NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: nhsd-resource-identifier

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier Version: 4.0.1
Draft as of 2022-07-24 Computable Name: NHSDResourceIdentifier

Copyright/Legal: Copyright © 2022 Healthdirect Australia - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This identifier profile defines a NHSD Identifer to be used by each resource entity - Organization, Location, Healthcare Servce and Practitioner (not required for Practitioner Role).

Extension: nhsd-resource-identifier

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Identifier 0..* Identifier NHSD Resource Identifer
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... system Σ 1..1 uri Vendor allocated URL
Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid
... value Σ 1..1 string RID
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Identifier 0..* Identifier NHSD Resource Identifer
... system 1..1 uri Vendor allocated URL
Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid
... value 1..1 string RID

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Identifier 0..* Identifier NHSD Resource Identifer
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... system Σ 1..1 uri Vendor allocated URL
Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid
... value Σ 1..1 string RID
Example General: 123456
... period Σ 0..1 Period Time period when id is/was valid for use
... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Identifier 0..* Identifier NHSD Resource Identifer
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... system Σ 1..1 uri Vendor allocated URL
Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid
... value Σ 1..1 string RID
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Identifier 0..* Identifier NHSD Resource Identifer
... system 1..1 uri Vendor allocated URL
Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid
... value 1..1 string RID

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Identifier 0..* Identifier NHSD Resource Identifer
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... system Σ 1..1 uri Vendor allocated URL
Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid
... value Σ 1..1 string RID
Example General: 123456
... period Σ 0..1 Period Time period when id is/was valid for use
... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Please refer to NHSD HealthcareService for implementation examples on identifier usage.