HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | Version: 1.1.0 | |||
Active as of 2020-07-20 | Computable Name: Nz_citizenship | |||
Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved. |
New Zealand citizenship
Context of Use
This extension may be used on the following element(s)
Patient
Example of extension
...
<extension url="http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship">
<extension url="status">
<valueCodeableConcept>
<coding>
<system value="https://standards.digital.health.nz/ns/nz-citizenship-status-code"/>
<code value="yes"/>
<display value="Yes"/>
</coding>
</valueCodeableConcept>
</extension>
<extension url="source">
<valueCodeableConcept>
<coding>
<system value="https://standards.digital.health.nz/ns/information-source-code"/>
<code value="BREG"/>
<display value="Birth Register"/>
</coding>
</valueCodeableConcept>
</extension>
</extension>
...
Example instances
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | NZ Citizenship | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred) | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | NZ Citizenship | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred) | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() |
This structure is derived from Extension
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | NZ Citizenship | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred) | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | NZ Citizenship | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "status" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NZ Citizenship status (preferred) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "source" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred) | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship" | |
![]() |
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | URI |
Extension.extension:status.value[x] | preferred | CitizenshipStatus(a valid code from NZ Citizenship status)https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code From this IG | |
Extension.extension:source.value[x] | preferred | InformationSource(a valid code from Information Source)https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code From this IG |
Id | Grade | Path(s) | Details | Requirements |
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() |