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
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Identifier | NHSD Resource Identifer | |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
Σ | 1..1 | uri | Vendor allocated URL Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid |
![]() ![]() |
Σ | 1..1 | string | RID Example General: 123456 |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Identifier | NHSD Resource Identifer | |
![]() ![]() |
1..1 | uri | Vendor allocated URL Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid | |
![]() ![]() |
1..1 | string | RID | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Identifier | NHSD Resource Identifer | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() |
Σ | 1..1 | uri | Vendor allocated URL Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid |
![]() ![]() |
Σ | 1..1 | string | RID Example General: 123456 |
![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format | ||||
| 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. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Identifier | NHSD Resource Identifer | |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
Σ | 1..1 | uri | Vendor allocated URL Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid |
![]() ![]() |
Σ | 1..1 | string | RID Example General: 123456 |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Identifier | NHSD Resource Identifer | |
![]() ![]() |
1..1 | uri | Vendor allocated URL Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid | |
![]() ![]() |
1..1 | string | RID | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Identifier | NHSD Resource Identifer | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() |
Σ | 1..1 | uri | Vendor allocated URL Fixed Value: http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#rid |
![]() ![]() |
Σ | 1..1 | string | RID Example General: 123456 |
![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format | ||||
| 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. |
| 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
Other representations of profile: CSV, Excel, Schematron
Please refer to NHSD HealthcareService for implementation examples on identifier usage.