Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build New Zealand flag

Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

Resource Profile: NZCentralRegionPatient - Detailed Descriptions

Active as of 2024-09-17

Definitions for the NZCentralRegionPatient resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Patient
2. Patient.meta
4. Patient.meta.extension
Control1..?
6. Patient.meta.extension:hl7v2Message
Slice Namehl7v2Message
Control1..1
TypeExtension(HL7 v2 Message) (Extension Type: base64Binary)
Must Supporttrue
8. Patient.meta.extension:hl7v2Message.url
10. Patient.meta.extension:hl7v2Message.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
12. Patient.meta.extension:process-timestamp
Slice Nameprocess-timestamp
Control0..1
TypeExtension(Process TimeStamp) (Extension Type: dateTime)
Must Supporttrue
14. Patient.meta.extension:source-event-trigger
Slice Namesource-event-trigger
Control0..1
TypeExtension(Source Event Trigger) (Extension Type: CodeableConcept)
Must Supporttrue
16. Patient.meta.extension:source-record-type
Slice Namesource-record-type
Control0..1
TypeExtension(Source Record Type) (Extension Type: CodeableConcept)
Must Supporttrue
18. Patient.meta.extension:source-record-id
Slice Namesource-record-id
Control0..1
TypeExtension(Source Record ID) (Extension Type: string)
Must Supporttrue
20. Patient.meta.extension:source-data-mode-version
Slice Namesource-data-mode-version
Control0..1
TypeExtension(Source Data Model Version) (Extension Type: string)
Must Supporttrue
22. Patient.meta.extension:process-client-id
Slice Nameprocess-client-id
Control0..1
TypeExtension(Process Client ID) (Extension Type: string)
Must Supporttrue
24. Patient.meta.extension:l4h-template-version
Slice Namel4h-template-version
Control0..1
TypeExtension(L4H Template Version) (Extension Type: string)
Must Supporttrue
26. Patient.implicitRules
Control0..0
28. Patient.language
Control0..0
30. Patient.contained
Control0..0
32. Patient.extension:ethnicity
Slice Nameethnicity
34. Patient.extension:ethnicity.url
36. Patient.extension:ethnicity.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
38. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding
40. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.system
42. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.code
44. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.display
46. Patient.extension:nzCitizen
Slice NamenzCitizen
Must Supporttrue
48. Patient.extension:nzCitizen.id
Control0..0
50. Patient.extension:nzCitizen.extension
Control1..?
52. Patient.extension:nzCitizen.extension:status
Slice Namestatus
Control1..?
Must Supporttrue
54. Patient.extension:nzCitizen.extension:status.id
Control0..0
56. Patient.extension:nzCitizen.extension:status.url
58. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
60. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.id
ShortIs this person a New Zealand citizen? CodeableConcept: yes / no / unknown
Control0..0
62. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding
Control1..1
Must Supporttrue
64. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.system
Control1..?
Must Supporttrue
66. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.version
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..0
68. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.code
Control1..?
Must Supporttrue
70. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.display
Control1..?
Must Supporttrue
72. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.userSelected
Control0..0
74. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.text
Control0..0
76. Patient.extension:nzCitizen.extension:source
Slice Namesource
Control0..0
78. Patient.extension:nzCitizen.url
80. Patient.extension:dhb
Slice Namedhb
Must Supporttrue
82. Patient.extension:dhb.id
Control0..0
84. Patient.extension:dhb.url
86. Patient.extension:dhb.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
88. Patient.extension:dhb.value[x].coding
Control1..1
Must Supporttrue
90. Patient.extension:dhb.value[x].coding.system
Control1..?
Must Supporttrue
92. Patient.extension:dhb.value[x].coding.version
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..0
94. Patient.extension:dhb.value[x].coding.code
Control1..?
Must Supporttrue
96. Patient.extension:dhb.value[x].coding.display
Control1..?
Must Supporttrue
98. Patient.extension:dhb.value[x].coding.userSelected
Control0..0
100. Patient.extension:dhb.value[x].text
Control0..0
102. Patient.extension:domicile-code
Slice Namedomicile-code
Must Supporttrue
104. Patient.extension:domicile-code.id
Control0..0
106. Patient.extension:domicile-code.url
108. Patient.extension:domicile-code.value[x]:valueCodeableConcept
Slice NamevalueCodeableConcept
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
110. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding
Control1..1
Must Supporttrue
112. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.system
Control1..?
Must Supporttrue
114. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.version
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..0
116. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.code
Control1..?
Must Supporttrue
118. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.display
Must Supporttrue
120. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected
Control0..0
122. Patient.extension:domicile-code.value[x]:valueCodeableConcept.text
Control0..0
124. Patient.extension:pho
Slice Namepho
Control0..0
126. Patient.extension:sex-at-birth
Slice Namesex-at-birth
Control0..0
128. Patient.extension:iwi
Slice Nameiwi
Control0..0
130. Patient.extension:nzcrEthnicity
Slice NamenzcrEthnicity
Control0..3
TypeExtension(NZ Ethnicity (Central Region Edition)) (Extension Type: CodeableConcept)
Must Supporttrue
132. Patient.extension:nzcrEthnicity.id
Control0..0
134. Patient.extension:nzcrEthnicity.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
136. Patient.extension:nzcrEthnicity.value[x].coding
Control2..?
Must Supporttrue
SlicingThis element introduces a set of slices on Patient.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • pattern @ system
  • 138. Patient.extension:nzcrEthnicity.value[x].coding.system
    Control1..?
    Must Supporttrue
    140. Patient.extension:nzcrEthnicity.value[x].coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    142. Patient.extension:nzcrEthnicity.value[x].coding.code
    Control1..?
    Must Supporttrue
    144. Patient.extension:nzcrEthnicity.value[x].coding.display
    Control1..?
    Must Supporttrue
    146. Patient.extension:nzcrEthnicity.value[x].coding.userSelected
    Control0..0
    148. Patient.extension:nzcrEthnicity.value[x].coding:level2
    Slice Namelevel2
    Control1..1
    150. Patient.extension:nzcrEthnicity.value[x].coding:level2.system
    Control1..?
    Must Supporttrue
    Fixed Valuehttps://standards.digital.health.nz/ns/ethnic-group-level-2-code
    152. Patient.extension:nzcrEthnicity.value[x].coding:level2.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    154. Patient.extension:nzcrEthnicity.value[x].coding:level2.code
    Control1..?
    BindingThe codes SHALL be taken from NZ Central Region - Ethnicity Level 2 Value Set
    (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2)
    Must Supporttrue
    156. Patient.extension:nzcrEthnicity.value[x].coding:level2.display
    Control1..?
    Must Supporttrue
    158. Patient.extension:nzcrEthnicity.value[x].coding:level2.userSelected
    Control0..0
    160. Patient.extension:nzcrEthnicity.value[x].coding:level4
    Slice Namelevel4
    Control1..1
    162. Patient.extension:nzcrEthnicity.value[x].coding:level4.system
    Control1..?
    Must Supporttrue
    Fixed Valuehttps://standards.digital.health.nz/ns/ethnic-group-level-4-code
    164. Patient.extension:nzcrEthnicity.value[x].coding:level4.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    166. Patient.extension:nzcrEthnicity.value[x].coding:level4.code
    Control1..?
    BindingThe codes SHALL be taken from Ethnicity of a person
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code)
    Must Supporttrue
    168. Patient.extension:nzcrEthnicity.value[x].coding:level4.display
    Control1..?
    Must Supporttrue
    170. Patient.extension:nzcrEthnicity.value[x].coding:level4.userSelected
    Control0..0
    172. Patient.extension:nzcrEthnicity.value[x].text
    Control0..0
    174. Patient.extension:nzcrResidency
    Slice NamenzcrResidency
    Control0..1
    TypeExtension(NZ Residency (Central Region Edition)) (Complex Extension)
    Must Supporttrue
    176. Patient.extension:nzcrResidency.id
    Control0..0
    178. Patient.extension:nzcrResidency.extension:status
    Slice Namestatus
    180. Patient.extension:nzcrResidency.extension:status.id
    Control0..0
    182. Patient.extension:nzcrResidency.extension:status.url
    184. Patient.extension:nzcrResidency.extension:status.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    186. Patient.extension:nzcrResidency.extension:status.value[x].coding
    Control2..?
    Must Supporttrue
    SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ system
    • 188. Patient.extension:nzcrResidency.extension:status.value[x].coding.system
      Control1..?
      Must Supporttrue
      190. Patient.extension:nzcrResidency.extension:status.value[x].coding.version
      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..0
      192. Patient.extension:nzcrResidency.extension:status.value[x].coding.code
      Control1..?
      Must Supporttrue
      194. Patient.extension:nzcrResidency.extension:status.value[x].coding.display
      Control1..?
      Must Supporttrue
      196. Patient.extension:nzcrResidency.extension:status.value[x].coding.userSelected
      Control0..0
      198. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase
      Slice NamenzBase
      Control1..1
      200. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.system
      Control1..?
      Must Supporttrue
      Pattern Valuehttps://standards.digital.health.nz/ns/nz-residency-code
      202. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.version
      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..0
      204. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code
      Control1..?
      BindingThe codes SHALL be taken from NZ Residency status
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code)
      Must Supporttrue
      206. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.display
      Control1..?
      Must Supporttrue
      208. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.userSelected
      Control0..0
      210. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource
      Slice NamerawSource
      Control1..1
      212. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.system
      Control1..?
      Must Supporttrue
      Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-residency-code
      214. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.version
      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..0
      216. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code
      Control1..?
      BindingThe codes SHALL be taken from NZ Central Region - NZ Residency Value Set
      (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency)
      Must Supporttrue
      218. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.display
      Control1..?
      Must Supporttrue
      220. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.userSelected
      Control0..0
      222. Patient.extension:nzcrResidency.extension:status.value[x].text
      Control0..0
      224. Patient.extension:nzcrResidency.extension:source
      Slice Namesource
      Control0..0
      226. Patient.extension:nzcrResidency.url
      228. Patient.extension:nzcrReligion
      Slice NamenzcrReligion
      Control0..1
      TypeExtension(Religious Affiliation (Central Region Edition)) (Extension Type: CodeableConcept)
      Must Supporttrue
      230. Patient.extension:nzcrReligion.url
      232. Patient.extension:nzcrReligion.value[x]
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      234. Patient.extension:nzcrReligion.value[x].id
      Control0..0
      236. Patient.extension:nzcrReligion.value[x].coding
      Control1..?
      Must Supporttrue
      SlicingThis element introduces a set of slices on Patient.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • pattern @ system
      • 238. Patient.extension:nzcrReligion.value[x].coding.system
        Control1..?
        Must Supporttrue
        240. Patient.extension:nzcrReligion.value[x].coding.version
        NoteThis is a business version Id, not a resource version Id (see discussion)
        Control0..0
        242. Patient.extension:nzcrReligion.value[x].coding.code
        Control1..?
        Must Supporttrue
        244. Patient.extension:nzcrReligion.value[x].coding.display
        Control1..?
        Must Supporttrue
        246. Patient.extension:nzcrReligion.value[x].coding.userSelected
        Control0..0
        248. Patient.extension:nzcrReligion.value[x].coding:origFhir
        Slice NameorigFhir
        Control0..1
        250. Patient.extension:nzcrReligion.value[x].coding:origFhir.system
        Control1..?
        Must Supporttrue
        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
        252. Patient.extension:nzcrReligion.value[x].coding:origFhir.version
        NoteThis is a business version Id, not a resource version Id (see discussion)
        Control0..0
        254. Patient.extension:nzcrReligion.value[x].coding:origFhir.code
        Control1..?
        BindingThe codes SHALL be taken from ReligiousAffiliation
        (required to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation)
        Must Supporttrue
        256. Patient.extension:nzcrReligion.value[x].coding:origFhir.display
        Control1..?
        Must Supporttrue
        258. Patient.extension:nzcrReligion.value[x].coding:origFhir.userSelected
        Control0..0
        260. Patient.extension:nzcrReligion.value[x].coding:rawSource
        Slice NamerawSource
        Control1..1
        262. Patient.extension:nzcrReligion.value[x].coding:rawSource.system
        Control1..?
        Must Supporttrue
        Fixed Valuehttps://standards.digital.health.nz/ns/central-region/patient-religion
        264. Patient.extension:nzcrReligion.value[x].coding:rawSource.version
        NoteThis is a business version Id, not a resource version Id (see discussion)
        Control0..0
        266. Patient.extension:nzcrReligion.value[x].coding:rawSource.code
        Control1..?
        BindingThe codes SHALL be taken from NZ Central Region - Combined Religion Value Set
        (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion)
        Must Supporttrue
        268. Patient.extension:nzcrReligion.value[x].coding:rawSource.display
        Control1..?
        Must Supporttrue
        270. Patient.extension:nzcrReligion.value[x].coding:rawSource.userSelected
        Control0..0
        272. Patient.extension:nzcrReligion.value[x].text
        Control0..0
        274. Patient.extension:interpreterRequired
        Slice NameinterpreterRequired
        Control0..1
        TypeExtension(Patient Interpreter Required) (Extension Type: boolean)
        Must Supporttrue
        276. Patient.extension:interpreterRequired.url
        278. Patient.extension:interpreterRequired.value[x]
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        280. Patient.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..?
        Must Supporttrue
        282. Patient.identifier.id
        Control0..0
        284. Patient.identifier.extension
        Control0..0
        286. Patient.identifier.use
        Control1..?
        Must Supporttrue
        288. Patient.identifier.type
        Control1..?
        Must Supporttrue
        290. Patient.identifier.type.coding
        Must Supporttrue
        292. Patient.identifier.type.coding.system
        Control1..?
        Must Supporttrue
        294. Patient.identifier.type.coding.code
        Control1..?
        Must Supporttrue
        296. Patient.identifier.type.coding.display
        Control1..?
        Must Supporttrue
        298. Patient.identifier.system
        Control1..?
        Must Supporttrue
        300. Patient.identifier.value
        Control1..?
        Must Supporttrue
        302. Patient.identifier.period
        Control0..0
        304. Patient.identifier.assigner
        Control0..0
        306. Patient.identifier:NHI
        Slice NameNHI
        NoteThis is a business identifier, not a resource identifier (see discussion)
        308. Patient.identifier:NHI.id
        Control0..0
        310. Patient.identifier:NHI.extension
        Control0..0
        312. Patient.identifier:NHI.use
        Control1..?
        Must Supporttrue
        314. Patient.identifier:NHI.type
        Control1..?
        Must Supporttrue
        316. Patient.identifier:NHI.system
        Must Supporttrue
        318. Patient.identifier:NHI.value
        Control1..?
        Must Supporttrue
        320. Patient.identifier:NHI.period
        Control0..0
        322. Patient.identifier:NHI.assigner
        Control0..0
        324. Patient.name
        Control1..?
        Must Supporttrue
        326. Patient.name.id
        Control0..0
        328. Patient.name.extension
        Control0..0
        330. Patient.name.use
        Shortone of: usual / old
        Control1..?
        Must Supporttrue
        332. Patient.name.text
        Control1..?
        Must Supporttrue
        334. Patient.name.family
        Control1..?
        Must Supporttrue
        336. Patient.name.given
        Must Supporttrue
        338. Patient.name.prefix
        Must Supporttrue
        340. Patient.name.suffix
        Control0..0
        342. Patient.telecom
        Must Supporttrue
        344. Patient.telecom.id
        Control0..0
        346. Patient.telecom.extension
        Control0..0
        348. Patient.telecom.extension:cp-purpose
        Slice Namecp-purpose
        Control0..0
        350. Patient.telecom.system
        Control1..?
        Must Supporttrue
        352. Patient.telecom.value
        Control1..?
        Must Supporttrue
        354. Patient.telecom.use
        Control1..?
        Must Supporttrue
        356. Patient.telecom.rank
        Control0..0
        358. Patient.telecom.period
        Control0..0
        360. Patient.gender
        Control1..?
        Must Supporttrue
        362. Patient.birthDate
        Control1..?
        Must Supporttrue
        LOINC Code
        364. Patient.deceased[x]
        ShortdeceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known
        Control1..?
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Must Supporttrue
        SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 366. Patient.deceased[x]:deceasedDateTime
          Slice NamedeceasedDateTime
          Control0..1
          TypedateTime
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          368. Patient.deceased[x]:deceasedBoolean
          Slice NamedeceasedBoolean
          Control0..1
          Typeboolean
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          370. Patient.address
          Must Supporttrue
          372. Patient.address.id
          Control0..0
          374. Patient.address.extension:nz-geocode
          Slice Namenz-geocode
          Control0..0
          376. Patient.address.extension:suburb
          Slice Namesuburb
          Must Supporttrue
          378. Patient.address.extension:suburb.url
          380. Patient.address.extension:suburb.value[x]
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          382. Patient.address.extension:building-name
          Slice Namebuilding-name
          Control0..0
          384. Patient.address.extension:domicile-code
          Slice Namedomicile-code
          Must Supporttrue
          386. Patient.address.extension:domicile-code.id
          Control0..0
          388. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept
          Slice NamevalueCodeableConcept
          TypeCodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          390. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding
          Control1..1
          Must Supporttrue
          392. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.system
          Control1..?
          Must Supporttrue
          394. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.version
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..0
          396. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.code
          Control1..?
          Must Supporttrue
          398. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.display
          Must Supporttrue
          400. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected
          Control0..0
          402. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.text
          Control0..0
          404. Patient.address.use
          Control1..?
          Must Supporttrue
          406. Patient.address.type
          ShortPHYSICAL | POSTAL
          Control1..?
          Must Supporttrue
          408. Patient.address.text
          Control0..0
          410. Patient.address.line
          Control0..2
          Must Supporttrue
          412. Patient.address.city
          Must Supporttrue
          414. Patient.address.district
          Control0..0
          416. Patient.address.state
          Must Supporttrue
          418. Patient.address.postalCode
          Must Supporttrue
          420. Patient.address.country
          Must Supporttrue
          422. Patient.address.period
          Control0..0
          424. Patient.maritalStatus
          Control1..?
          BindingThe codes SHALL be taken from NZ Central Region - Marital Status Value Set
          (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status)
          Must Supporttrue
          426. Patient.maritalStatus.id
          Control0..0
          428. Patient.maritalStatus.extension
          Control0..0
          430. Patient.maritalStatus.coding
          Control1..?
          Must Supporttrue
          432. Patient.maritalStatus.coding.id
          Control0..0
          434. Patient.maritalStatus.coding.extension
          Control0..0
          436. Patient.maritalStatus.coding.system
          Control1..?
          Must Supporttrue
          438. Patient.maritalStatus.coding.version
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..0
          440. Patient.maritalStatus.coding.code
          Control1..?
          Must Supporttrue
          442. Patient.maritalStatus.coding.display
          Control1..?
          Must Supporttrue
          444. Patient.maritalStatus.coding.userSelected
          Control0..0
          446. Patient.maritalStatus.text
          Control0..0
          448. Patient.multipleBirth[x]
          Control0..0
          450. Patient.photo
          Control0..0
          452. Patient.contact
          Must Supporttrue
          454. Patient.contact.id
          Control0..0
          456. Patient.contact.extension
          Control0..0
          458. Patient.contact.relationship
          Control1..1
          Must Supporttrue
          460. Patient.contact.relationship.id
          Control0..0
          462. Patient.contact.relationship.extension:contact-relationship
          Slice Namecontact-relationship
          Control0..1
          TypeExtension(Contact Relationship) (Extension Type: Coding)
          Must Supporttrue
          464. Patient.contact.relationship.extension:contact-relationship.value[x]
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          466. Patient.contact.relationship.extension:contact-relationship.value[x].system
          468. Patient.contact.relationship.extension:contact-relationship.value[x].code
          470. Patient.contact.relationship.extension:contact-relationship.value[x].display
          472. Patient.contact.relationship.coding
          474. Patient.contact.relationship.coding.id
          Control0..0
          476. Patient.contact.relationship.coding.extension
          Control0..0
          478. Patient.contact.relationship.coding.system
          Control1..?
          Must Supporttrue
          480. Patient.contact.relationship.coding.version
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..0
          482. Patient.contact.relationship.coding.code
          Control1..?
          Must Supporttrue
          484. Patient.contact.relationship.coding.display
          Control1..?
          Must Supporttrue
          486. Patient.contact.relationship.coding.userSelected
          Control0..0
          488. Patient.contact.relationship.text
          Control0..0
          490. Patient.contact.name
          Control1..?
          Must Supporttrue
          492. Patient.contact.name.id
          Control0..0
          494. Patient.contact.name.extension
          Control0..0
          496. Patient.contact.name.use
          Control0..0
          498. Patient.contact.name.text
          Control1..?
          Must Supporttrue
          500. Patient.contact.name.family
          Control1..?
          Must Supporttrue
          502. Patient.contact.name.given
          Must Supporttrue
          504. Patient.contact.name.prefix
          Control0..1
          Must Supporttrue
          506. Patient.contact.name.suffix
          Control0..0
          508. Patient.contact.telecom
          Must Supporttrue
          510. Patient.contact.telecom.id
          Control0..0
          512. Patient.contact.telecom.extension
          Control0..0
          514. Patient.contact.telecom.system
          Control1..?
          Must Supporttrue
          516. Patient.contact.telecom.value
          Control1..?
          Must Supporttrue
          518. Patient.contact.telecom.use
          Control1..?
          Must Supporttrue
          520. Patient.contact.telecom.rank
          Control0..0
          522. Patient.contact.address
          Control0..0
          524. Patient.contact.gender
          Control0..0
          526. Patient.contact.organization
          Control0..0
          528. Patient.contact.period
          Must Supporttrue
          530. Patient.communication
          Must Supporttrue
          532. Patient.communication.id
          Control0..0
          534. Patient.communication.extension
          Control0..0
          536. Patient.communication.language
          BindingThe codes SHOULD be taken from CommonLanguages
          (preferred to http://hl7.org/fhir/ValueSet/languages)

          A human language.

          Additional BindingsPurpose
          AllLanguagesMax Binding
          NZ Central Region - Raw Language Value Value SetRequired
          Must Supporttrue
          538. Patient.communication.language.id
          Control0..0
          540. Patient.communication.language.extension
          Control0..0
          542. Patient.communication.language.coding
          544. Patient.communication.language.coding.id
          Control0..0
          546. Patient.communication.language.coding.extension
          Control0..0
          548. Patient.communication.language.coding.system
          Must Supporttrue
          550. Patient.communication.language.coding.version
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..0
          552. Patient.communication.language.coding.code
          Must Supporttrue
          554. Patient.communication.language.coding.display
          Must Supporttrue
          556. Patient.communication.language.coding.userSelected
          Control0..0
          558. Patient.communication.preferred
          Must Supporttrue
          560. Patient.generalPractitioner
          Control0..1
          Must Supporttrue
          562. Patient.generalPractitioner.id
          Control0..0
          564. Patient.generalPractitioner.extension
          Control0..0
          566. Patient.generalPractitioner.reference
          Must Supporttrue
          568. Patient.generalPractitioner.type
          Control1..?
          Must Supporttrue
          570. Patient.generalPractitioner.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control1..?
          Must Supporttrue
          572. Patient.generalPractitioner.identifier.id
          Control0..0
          574. Patient.generalPractitioner.identifier.extension
          Control0..0
          576. Patient.generalPractitioner.identifier.use
          Control1..?
          Must Supporttrue
          578. Patient.generalPractitioner.identifier.type
          Control1..?
          Must Supporttrue
          580. Patient.generalPractitioner.identifier.type.id
          Control0..0
          582. Patient.generalPractitioner.identifier.type.extension
          Control0..0
          584. Patient.generalPractitioner.identifier.type.coding
          Must Supporttrue
          586. Patient.generalPractitioner.identifier.type.coding.id
          Control0..0
          588. Patient.generalPractitioner.identifier.type.coding.extension
          Control0..0
          590. Patient.generalPractitioner.identifier.type.coding.system
          Control1..?
          Must Supporttrue
          Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
          592. Patient.generalPractitioner.identifier.type.coding.version
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..0
          594. Patient.generalPractitioner.identifier.type.coding.code
          Control1..?
          Must Supporttrue
          Pattern ValueLR
          596. Patient.generalPractitioner.identifier.type.coding.display
          Control1..?
          Must Supporttrue
          Pattern ValueLocal Registry ID
          598. Patient.generalPractitioner.identifier.type.coding.userSelected
          Control0..0
          600. Patient.generalPractitioner.identifier.type.text
          Control0..0
          602. Patient.generalPractitioner.identifier.system
          Control1..?
          Must Supporttrue
          Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-practitioner-id
          604. Patient.generalPractitioner.identifier.value
          606. Patient.generalPractitioner.identifier.period
          Control0..0
          608. Patient.generalPractitioner.identifier.assigner
          Control0..0
          610. Patient.generalPractitioner.display
          Must Supporttrue
          612. Patient.managingOrganization
          Control0..0
          614. Patient.link
          Must Supporttrue
          616. Patient.link.id
          Control0..0
          618. Patient.link.extension
          Control0..0
          620. Patient.link.other
          Must Supporttrue
          622. Patient.link.other.reference
          Control0..0
          624. Patient.link.other.type
          ShortPatient
          Must Supporttrue
          Pattern ValuePatient
          626. Patient.link.other.identifier
          ShortBusiness-level identifier for the Patient being replaced
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control1..?
          Must Supporttrue
          628. Patient.link.other.display
          Control0..0
          630. Patient.link.type
          Shortreplaced-by | replaces
          Must Supporttrue

          Guidance on how to interpret the contents of this table can be found here

          0. Patient
          Definition

          Demographics and other administrative information about an individual or animal receiving care or other health-related services.

          ShortInformation about an individual or animal receiving health care services
          Control0..*
          Is Modifierfalse
          Summaryfalse
          Alternate NamesSubjectOfCare Client Resident
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          nz-pat-1: only a single official NHI (Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2)
          2. Patient.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          4. Patient.meta.extension
          Definition

          An Extension


          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortExtensionAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control10..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 6. Patient.meta.extension:hl7v2Message
            Slice Namehl7v2Message
            Definition

            Base64 encoded string containing the original HL7 v2 message that was used to create / update the FHIR resource

            ShortHL7 v2 Message
            Control1..1
            TypeExtension(HL7 v2 Message) (Extension Type: base64Binary)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            8. Patient.meta.extension:hl7v2Message.extension
            Definition

            An Extension


            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortExtensionAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..0*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Patient.meta.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 10. Patient.meta.extension:hl7v2Message.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttps://standards.digital.health.nz/ns/central-region/hl7v2-message
              12. Patient.meta.extension:hl7v2Message.value[x]
              Definition

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              ShortValue of extension
              Control0..1
              Typebase64Binary, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              14. Patient.meta.extension:process-timestamp
              Slice Nameprocess-timestamp
              Definition

              Date and time the source HL7v2 message was translated into FHIR Resource

              ShortProcess TimeStamp
              Control0..1
              TypeExtension(Process TimeStamp) (Extension Type: dateTime)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              16. Patient.meta.extension:source-event-trigger
              Slice Namesource-event-trigger
              Definition

              The HL7v2 message/event trigger that was translated into FHIR Resource (eg A31, I13, etc)

              ShortSource Event Trigger
              Control0..1
              TypeExtension(Source Event Trigger) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              18. Patient.meta.extension:source-record-type
              Slice Namesource-record-type
              Definition

              The HL7v2 record type that was translated into FHIR Resource (eg ADT, REF, etc)

              ShortSource Record Type
              Control0..1
              TypeExtension(Source Record Type) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              20. Patient.meta.extension:source-record-id
              Slice Namesource-record-id
              Definition

              The HL7v2 record ID that was translated into FHIR Resource

              ShortSource Record ID
              Control0..1
              TypeExtension(Source Record ID) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              22. Patient.meta.extension:source-data-mode-version
              Slice Namesource-data-mode-version
              Definition

              The HL7v2 version number for the message/event that was translated into FHIR Resource

              ShortSource Data Model Version
              Control0..1
              TypeExtension(Source Data Model Version) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              24. Patient.meta.extension:process-client-id
              Slice Nameprocess-client-id
              Definition

              The HL7v2 Source Client Id for the message/event that was translated into FHIR Resource

              ShortProcess Client ID
              Control0..1
              TypeExtension(Process Client ID) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              26. Patient.meta.extension:l4h-template-version
              Slice Namel4h-template-version
              Definition

              The version number of the l4h templates used to translate the hl7v2 message into FHIR Resource

              ShortL4H Template Version
              Control0..1
              TypeExtension(L4H Template Version) (Extension Type: string)
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              28. Patient.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..01
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              30. Patient.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..01
              BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
              (preferred to http://hl7.org/fhir/ValueSet/languages)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              32. Patient.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

              Control0..0*
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              34. Patient.extension:ethnicity
              Slice Nameethnicity
              Definition

              The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

              The Stats New Zealand standard can be found here.

              ShortNZ Ethnicity
              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(NZ Ethnicity) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              36. Patient.extension:ethnicity.extension
              Definition

              An Extension


              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortExtensionAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..0*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 38. Patient.extension:ethnicity.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                Comments

                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
                40. Patient.extension:ethnicity.value[x]
                Definition

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                ShortValue of extension
                Control10..1
                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • type @ $this
                • 42. Patient.extension:ethnicity.value[x]:valueCodeableConcept
                  Slice NamevalueCodeableConcept
                  Definition

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                  ShortValue of extension
                  Control10..1
                  BindingThe codes SHOULD be taken from For codes, see Ethnicity of a person
                  (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code)
                  TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  44. Patient.extension:nzCitizen
                  Slice NamenzCitizen
                  Definition

                  New Zealand citizenship

                  ShortNZ Citizenship
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(NZ Citizenship) (Complex Extension)
                  Is Modifierfalse
                  Must Supporttrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  46. Patient.extension:nzCitizen.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..01
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  48. Patient.extension:nzCitizen.extension
                  Definition

                  An Extension


                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortExtensionAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control10..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 50. Patient.extension:nzCitizen.extension:status
                    Slice Namestatus
                    Definition

                    An Extension

                    ShortExtensionAdditional content defined by implementations
                    Control10..1*
                    TypeExtension
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    52. Patient.extension:nzCitizen.extension:status.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..01
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    54. Patient.extension:nzCitizen.extension:status.extension
                    Definition

                    An Extension


                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortExtensionAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..0*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 56. Patient.extension:nzCitizen.extension:status.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies the meaning of the extension
                      Comments

                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuestatus
                      58. Patient.extension:nzCitizen.extension:status.value[x]
                      Definition

                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                      ShortValue of extension
                      Control0..1
                      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 60. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept
                        Slice NamevalueCodeableConcept
                        Definition

                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                        ShortValue of extension
                        Control0..1
                        BindingThe codes SHOULD be taken from For codes, see NZ Citizenship status
                        (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code)
                        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        62. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortIs this person a New Zealand citizen? CodeableConcept: yes / no / unknownUnique id for inter-element referencing
                        Control0..01
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        64. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control10..1*
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        66. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.system
                        Definition

                        The identification of the code system that defines the meaning of the symbol in the code.

                        ShortIdentity of the terminology system
                        Comments

                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                        Control10..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to be unambiguous about the source of the definition of the symbol.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        68. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.version
                        Definition

                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                        ShortVersion of the system - if relevant
                        Comments

                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..01
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        70. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.code
                        Definition

                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                        ShortSymbol in syntax defined by the system
                        Control10..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        72. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.display
                        Definition

                        A representation of the meaning of the code in the system, following the rules of the system.

                        ShortRepresentation defined by the system
                        Control10..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        74. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.userSelected
                        Definition

                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                        ShortIf this coding was chosen directly by the user
                        Comments

                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                        Control0..01
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        76. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.text
                        Definition

                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                        ShortPlain text representation of the concept
                        Comments

                        Very often the text is the same as a displayName of one of the codings.

                        Control0..01
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        78. Patient.extension:nzCitizen.extension:source
                        Slice Namesource
                        Definition

                        An Extension

                        ShortExtensionAdditional content defined by implementations
                        Control0..0*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        84. Patient.extension:nzCitizen.url
                        Definition

                        Source of the definition for the extension code - a logical name or a URL.

                        Shortidentifies the meaning of the extension
                        Comments

                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
                        86. Patient.extension:nzCitizen.value[x]
                        Definition

                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                        ShortValue of extension
                        Control0..01
                        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        88. Patient.extension:dhb
                        Slice Namedhb
                        Definition

                        District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

                        ShortDistrict Health Board linked to a NZ Healthcare Service, Location or Patient
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)
                        Is Modifierfalse
                        Must Supporttrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        90. Patient.extension:dhb.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..01
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        92. Patient.extension:dhb.extension
                        Definition

                        An Extension


                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortExtensionAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..0*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 94. Patient.extension:dhb.url
                          Definition

                          Source of the definition for the extension code - a logical name or a URL.

                          Shortidentifies the meaning of the extension
                          Comments

                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/dhb
                          96. Patient.extension:dhb.value[x]
                          Definition

                          NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month.


                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                          ShortNZ District Health BoardsValue of extension
                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from For codes, see District Health Board Identifer
                          (extensible to https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code)

                          NZ HPI-ORG Values for DHBs

                          TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type.

                          LabelDHB Code
                          Example<br/><b>Waikato DHB</b>:{ "coding" : [{ "system" : "https://standards.digital.health.nz/ns/dhb-code", "version" : "1.0", "code" : "G00027-C", "display" : "Waikato" }] }
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          98. Patient.extension:dhb.value[x].coding
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control10..1*
                          TypeCoding
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Allows for alternative encodings within a code system, and translations to other code systems.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          100. Patient.extension:dhb.value[x].coding.system
                          Definition

                          The identification of the code system that defines the meaning of the symbol in the code.

                          ShortIdentity of the terminology system
                          Comments

                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                          Control10..1
                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Need to be unambiguous about the source of the definition of the symbol.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          102. Patient.extension:dhb.value[x].coding.version
                          Definition

                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                          ShortVersion of the system - if relevant
                          Comments

                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                          NoteThis is a business version Id, not a resource version Id (see discussion)
                          Control0..01
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          104. Patient.extension:dhb.value[x].coding.code
                          Definition

                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                          ShortSymbol in syntax defined by the system
                          Control10..1
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Need to refer to a particular code in the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          106. Patient.extension:dhb.value[x].coding.display
                          Definition

                          A representation of the meaning of the code in the system, following the rules of the system.

                          ShortRepresentation defined by the system
                          Control10..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          108. Patient.extension:dhb.value[x].coding.userSelected
                          Definition

                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                          ShortIf this coding was chosen directly by the user
                          Comments

                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                          Control0..01
                          Typeboolean
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          110. Patient.extension:dhb.value[x].text
                          Definition

                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                          ShortPlain text representation of the concept
                          Comments

                          Very often the text is the same as a displayName of one of the codings.

                          Control0..01
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          112. Patient.extension:domicile-code
                          Slice Namedomicile-code
                          Definition

                          NZ Domicile Code. Derived from a patient's primary physical, home address.

                          ShortNZ Domicile Code
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Must Supporttrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          114. Patient.extension:domicile-code.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..01
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          116. Patient.extension:domicile-code.extension
                          Definition

                          An Extension


                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortExtensionAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..0*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 118. Patient.extension:domicile-code.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/domicile-code
                            120. Patient.extension:domicile-code.value[x]
                            Definition

                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortValue of extension
                            Control0..1
                            TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            SlicingThis element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                            • type @ $this
                            • 122. Patient.extension:domicile-code.value[x]:valueCodeableConcept
                              Slice NamevalueCodeableConcept
                              Definition

                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                              ShortValue of extension
                              Control0..1
                              BindingThe codes SHOULD be taken from For codes, see Domicile Code
                              (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code)
                              TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              124. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding
                              Definition

                              A reference to a code defined by a terminology system.

                              ShortCode defined by a terminology system
                              Comments

                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                              Control10..1*
                              TypeCoding
                              Is Modifierfalse
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Allows for alternative encodings within a code system, and translations to other code systems.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              126. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.system
                              Definition

                              The identification of the code system that defines the meaning of the symbol in the code.

                              ShortIdentity of the terminology system
                              Comments

                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                              Control10..1
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Need to be unambiguous about the source of the definition of the symbol.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              128. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.version
                              Definition

                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                              ShortVersion of the system - if relevant
                              Comments

                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                              NoteThis is a business version Id, not a resource version Id (see discussion)
                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              130. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.code
                              Definition

                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                              ShortSymbol in syntax defined by the system
                              Control10..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              132. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.display
                              Definition

                              A representation of the meaning of the code in the system, following the rules of the system.

                              ShortRepresentation defined by the system
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              134. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected
                              Definition

                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                              ShortIf this coding was chosen directly by the user
                              Comments

                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                              Control0..01
                              Typeboolean
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              136. Patient.extension:domicile-code.value[x]:valueCodeableConcept.text
                              Definition

                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                              ShortPlain text representation of the concept
                              Comments

                              Very often the text is the same as a displayName of one of the codings.

                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              138. Patient.extension:pho
                              Slice Namepho
                              Definition

                              Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

                              ShortPrimary Healthcare Organisation
                              Control0..0
                              This element is affected by the following invariants: ele-1
                              TypeExtension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              140. Patient.extension:sex-at-birth
                              Slice Namesex-at-birth
                              Definition

                              A person’s sex at the time of their birth (considered to be immutable).

                              ShortSex At Birth
                              Control0..0
                              This element is affected by the following invariants: ele-1
                              TypeExtension(Sex At Birth) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              142. Patient.extension:iwi
                              Slice Nameiwi
                              Definition

                              Persons Iwi affiliation

                              ShortExtension
                              Control0..0
                              This element is affected by the following invariants: ele-1
                              TypeExtension(Nz_iwi) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              144. Patient.extension:nzcrEthnicity
                              Slice NamenzcrEthnicity
                              Definition

                              The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

                              The Stats New Zealand standard can be found here.

                              ShortNZ Ethnicity (Central Region Edition)
                              Control0..3
                              TypeExtension(NZ Ethnicity (Central Region Edition)) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              146. Patient.extension:nzcrEthnicity.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..01
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              148. Patient.extension:nzcrEthnicity.extension
                              Definition

                              An Extension


                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortExtensionAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..0*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 150. Patient.extension:nzcrEthnicity.url
                                Definition

                                Source of the definition for the extension code - a logical name or a URL.

                                Shortidentifies the meaning of the extension
                                Comments

                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-ethnicity
                                152. Patient.extension:nzcrEthnicity.value[x]
                                Definition

                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                ShortValue of extension
                                Control10..1
                                BindingThe codes SHALL be taken from For codes, see NZ Central Region - Combined Ethnicity Value Set
                                (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity)
                                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                154. Patient.extension:nzcrEthnicity.value[x].coding
                                Definition

                                A reference to a code defined by a terminology system.

                                ShortCode defined by a terminology system
                                Comments

                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                Control20..*
                                TypeCoding
                                Is Modifierfalse
                                Must Supporttrue
                                Summarytrue
                                Requirements

                                Allows for alternative encodings within a code system, and translations to other code systems.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                SlicingThis element introduces a set of slices on Patient.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • pattern @ system
                                • 156. Patient.extension:nzcrEthnicity.value[x].coding.system
                                  Definition

                                  The identification of the code system that defines the meaning of the symbol in the code.

                                  ShortIdentity of the terminology system
                                  Comments

                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                  Control10..1
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to be unambiguous about the source of the definition of the symbol.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  158. Patient.extension:nzcrEthnicity.value[x].coding.version
                                  Definition

                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                  ShortVersion of the system - if relevant
                                  Comments

                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..01
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  160. Patient.extension:nzcrEthnicity.value[x].coding.code
                                  Definition

                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                  ShortSymbol in syntax defined by the system
                                  Control10..1
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to refer to a particular code in the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  162. Patient.extension:nzcrEthnicity.value[x].coding.display
                                  Definition

                                  A representation of the meaning of the code in the system, following the rules of the system.

                                  ShortRepresentation defined by the system
                                  Control10..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  164. Patient.extension:nzcrEthnicity.value[x].coding.userSelected
                                  Definition

                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                  ShortIf this coding was chosen directly by the user
                                  Comments

                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                  Control0..01
                                  Typeboolean
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  166. Patient.extension:nzcrEthnicity.value[x].coding:level2
                                  Slice Namelevel2
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control10..1*
                                  TypeCoding
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  168. Patient.extension:nzcrEthnicity.value[x].coding:level2.system
                                  Definition

                                  The identification of the code system that defines the meaning of the symbol in the code.

                                  ShortIdentity of the terminology system
                                  Comments

                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                  Control10..1
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to be unambiguous about the source of the definition of the symbol.

                                  Fixed Valuehttps://standards.digital.health.nz/ns/ethnic-group-level-2-code
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  170. Patient.extension:nzcrEthnicity.value[x].coding:level2.version
                                  Definition

                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                  ShortVersion of the system - if relevant
                                  Comments

                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..01
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  172. Patient.extension:nzcrEthnicity.value[x].coding:level2.code
                                  Definition

                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                  ShortSymbol in syntax defined by the system
                                  Control10..1
                                  BindingThe codes SHALL be taken from For codes, see NZ Central Region - Ethnicity Level 2 Value Set
                                  (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2)
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to refer to a particular code in the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  174. Patient.extension:nzcrEthnicity.value[x].coding:level2.display
                                  Definition

                                  A representation of the meaning of the code in the system, following the rules of the system.

                                  ShortRepresentation defined by the system
                                  Control10..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  176. Patient.extension:nzcrEthnicity.value[x].coding:level2.userSelected
                                  Definition

                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                  ShortIf this coding was chosen directly by the user
                                  Comments

                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                  Control0..01
                                  Typeboolean
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  178. Patient.extension:nzcrEthnicity.value[x].coding:level4
                                  Slice Namelevel4
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control10..1*
                                  TypeCoding
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  180. Patient.extension:nzcrEthnicity.value[x].coding:level4.system
                                  Definition

                                  The identification of the code system that defines the meaning of the symbol in the code.

                                  ShortIdentity of the terminology system
                                  Comments

                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                  Control10..1
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to be unambiguous about the source of the definition of the symbol.

                                  Fixed Valuehttps://standards.digital.health.nz/ns/ethnic-group-level-4-code
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  182. Patient.extension:nzcrEthnicity.value[x].coding:level4.version
                                  Definition

                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                  ShortVersion of the system - if relevant
                                  Comments

                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..01
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  184. Patient.extension:nzcrEthnicity.value[x].coding:level4.code
                                  Definition

                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                  ShortSymbol in syntax defined by the system
                                  Control10..1
                                  BindingThe codes SHALL be taken from For codes, see Ethnicity of a person
                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code)
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to refer to a particular code in the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  186. Patient.extension:nzcrEthnicity.value[x].coding:level4.display
                                  Definition

                                  A representation of the meaning of the code in the system, following the rules of the system.

                                  ShortRepresentation defined by the system
                                  Control10..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  188. Patient.extension:nzcrEthnicity.value[x].coding:level4.userSelected
                                  Definition

                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                  ShortIf this coding was chosen directly by the user
                                  Comments

                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                  Control0..01
                                  Typeboolean
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  190. Patient.extension:nzcrEthnicity.value[x].text
                                  Definition

                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                  ShortPlain text representation of the concept
                                  Comments

                                  Very often the text is the same as a displayName of one of the codings.

                                  Control0..01
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  192. Patient.extension:nzcrResidency
                                  Slice NamenzcrResidency
                                  Definition

                                  NZ Residency status, permits multiple codings from different CodeSystems

                                  ShortNZ Residency (Central Region Edition)
                                  Control0..1
                                  TypeExtension(NZ Residency (Central Region Edition)) (Complex Extension)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  194. Patient.extension:nzcrResidency.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..01
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  196. Patient.extension:nzcrResidency.extension:status
                                  Slice Namestatus
                                  Definition

                                  An Extension

                                  ShortExtensionAdditional content defined by implementations
                                  Control0..1*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  198. Patient.extension:nzcrResidency.extension:status.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..01
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  200. Patient.extension:nzcrResidency.extension:status.extension
                                  Definition

                                  An Extension


                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                  ShortExtensionAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..0*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 202. Patient.extension:nzcrResidency.extension:status.url
                                    Definition

                                    Source of the definition for the extension code - a logical name or a URL.

                                    Shortidentifies the meaning of the extension
                                    Comments

                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    Fixed Valuestatus
                                    204. Patient.extension:nzcrResidency.extension:status.value[x]
                                    Definition

                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                    ShortValue of extension
                                    Control0..1
                                    BindingThe codes SHALL be taken from For codes, see NZ Central Region - Combined NZ Residency Value Set
                                    (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency)
                                    TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    206. Patient.extension:nzcrResidency.extension:status.value[x].coding
                                    Definition

                                    A reference to a code defined by a terminology system.

                                    ShortCode defined by a terminology system
                                    Comments

                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                    Control20..*
                                    TypeCoding
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • pattern @ system
                                    • 208. Patient.extension:nzcrResidency.extension:status.value[x].coding.system
                                      Definition

                                      The identification of the code system that defines the meaning of the symbol in the code.

                                      ShortIdentity of the terminology system
                                      Comments

                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                      Control10..1
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to be unambiguous about the source of the definition of the symbol.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      210. Patient.extension:nzcrResidency.extension:status.value[x].coding.version
                                      Definition

                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                      ShortVersion of the system - if relevant
                                      Comments

                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                      Control0..01
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      212. Patient.extension:nzcrResidency.extension:status.value[x].coding.code
                                      Definition

                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                      ShortSymbol in syntax defined by the system
                                      Control10..1
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to refer to a particular code in the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      214. Patient.extension:nzcrResidency.extension:status.value[x].coding.display
                                      Definition

                                      A representation of the meaning of the code in the system, following the rules of the system.

                                      ShortRepresentation defined by the system
                                      Control10..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      216. Patient.extension:nzcrResidency.extension:status.value[x].coding.userSelected
                                      Definition

                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                      ShortIf this coding was chosen directly by the user
                                      Comments

                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                      Control0..01
                                      Typeboolean
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      218. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase
                                      Slice NamenzBase
                                      Definition

                                      A reference to a code defined by a terminology system.

                                      ShortCode defined by a terminology system
                                      Comments

                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                      Control10..1*
                                      TypeCoding
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      220. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.system
                                      Definition

                                      The identification of the code system that defines the meaning of the symbol in the code.

                                      ShortIdentity of the terminology system
                                      Comments

                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                      Control10..1
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to be unambiguous about the source of the definition of the symbol.

                                      Pattern Valuehttps://standards.digital.health.nz/ns/nz-residency-code
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      222. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.version
                                      Definition

                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                      ShortVersion of the system - if relevant
                                      Comments

                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                      Control0..01
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      224. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code
                                      Definition

                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                      ShortSymbol in syntax defined by the system
                                      Control10..1
                                      BindingThe codes SHALL be taken from For codes, see NZ Residency status
                                      (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code)
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to refer to a particular code in the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      226. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.display
                                      Definition

                                      A representation of the meaning of the code in the system, following the rules of the system.

                                      ShortRepresentation defined by the system
                                      Control10..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      228. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.userSelected
                                      Definition

                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                      ShortIf this coding was chosen directly by the user
                                      Comments

                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                      Control0..01
                                      Typeboolean
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      230. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource
                                      Slice NamerawSource
                                      Definition

                                      A reference to a code defined by a terminology system.

                                      ShortCode defined by a terminology system
                                      Comments

                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                      Control10..1*
                                      TypeCoding
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      232. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.system
                                      Definition

                                      The identification of the code system that defines the meaning of the symbol in the code.

                                      ShortIdentity of the terminology system
                                      Comments

                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                      Control10..1
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to be unambiguous about the source of the definition of the symbol.

                                      Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-residency-code
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      234. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.version
                                      Definition

                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                      ShortVersion of the system - if relevant
                                      Comments

                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                      Control0..01
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      236. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code
                                      Definition

                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                      ShortSymbol in syntax defined by the system
                                      Control10..1
                                      BindingThe codes SHALL be taken from For codes, see NZ Central Region - NZ Residency Value Set
                                      (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency)
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to refer to a particular code in the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      238. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.display
                                      Definition

                                      A representation of the meaning of the code in the system, following the rules of the system.

                                      ShortRepresentation defined by the system
                                      Control10..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Requirements

                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      240. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.userSelected
                                      Definition

                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                      ShortIf this coding was chosen directly by the user
                                      Comments

                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                      Control0..01
                                      Typeboolean
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      242. Patient.extension:nzcrResidency.extension:status.value[x].text
                                      Definition

                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                      ShortPlain text representation of the concept
                                      Comments

                                      Very often the text is the same as a displayName of one of the codings.

                                      Control0..01
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      244. Patient.extension:nzcrResidency.extension:source
                                      Slice Namesource
                                      Definition

                                      An Extension

                                      ShortExtensionAdditional content defined by implementations
                                      Control0..0*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      248. Patient.extension:nzcrResidency.url
                                      Definition

                                      Source of the definition for the extension code - a logical name or a URL.

                                      Shortidentifies the meaning of the extension
                                      Comments

                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                      Control1..1
                                      Typeuri
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-residency
                                      250. Patient.extension:nzcrResidency.value[x]
                                      Definition

                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                      ShortValue of extension
                                      Control0..01
                                      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      252. Patient.extension:nzcrReligion
                                      Slice NamenzcrReligion
                                      Definition

                                      Patient religious affiliation extension, permits multiple codings from different CodeSystems

                                      ShortReligious Affiliation (Central Region Edition)
                                      Control0..1
                                      TypeExtension(Religious Affiliation (Central Region Edition)) (Extension Type: CodeableConcept)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      254. Patient.extension:nzcrReligion.extension
                                      Definition

                                      An Extension


                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      ShortExtensionAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..0*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 256. Patient.extension:nzcrReligion.url
                                        Definition

                                        Source of the definition for the extension code - a logical name or a URL.

                                        Shortidentifies the meaning of the extension
                                        Comments

                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Fixed Valuehttps://standards.digital.health.nz/ns/central-region/religion
                                        258. Patient.extension:nzcrReligion.value[x]
                                        Definition

                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                        ShortValue of extension
                                        Control10..1
                                        BindingThe codes SHALL be taken from For codes, see NZ Central Region - Combined Religion Value Set
                                        (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion)
                                        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        260. Patient.extension:nzcrReligion.value[x].id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..01
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        262. Patient.extension:nzcrReligion.value[x].coding
                                        Definition

                                        A reference to a code defined by a terminology system.

                                        ShortCode defined by a terminology system
                                        Comments

                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                        Control10..*
                                        TypeCoding
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Requirements

                                        Allows for alternative encodings within a code system, and translations to other code systems.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on Patient.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • pattern @ system
                                        • 264. Patient.extension:nzcrReligion.value[x].coding.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control10..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          266. Patient.extension:nzcrReligion.value[x].coding.version
                                          Definition

                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                          ShortVersion of the system - if relevant
                                          Comments

                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                          Control0..01
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          268. Patient.extension:nzcrReligion.value[x].coding.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control10..1
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          270. Patient.extension:nzcrReligion.value[x].coding.display
                                          Definition

                                          A representation of the meaning of the code in the system, following the rules of the system.

                                          ShortRepresentation defined by the system
                                          Control10..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          272. Patient.extension:nzcrReligion.value[x].coding.userSelected
                                          Definition

                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                          ShortIf this coding was chosen directly by the user
                                          Comments

                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                          Control0..01
                                          Typeboolean
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          274. Patient.extension:nzcrReligion.value[x].coding:origFhir
                                          Slice NameorigFhir
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..1*
                                          TypeCoding
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          276. Patient.extension:nzcrReligion.value[x].coding:origFhir.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control10..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          278. Patient.extension:nzcrReligion.value[x].coding:origFhir.version
                                          Definition

                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                          ShortVersion of the system - if relevant
                                          Comments

                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                          Control0..01
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          280. Patient.extension:nzcrReligion.value[x].coding:origFhir.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control10..1
                                          BindingThe codes SHALL be taken from For codes, see ReligiousAffiliation
                                          (required to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation)
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          282. Patient.extension:nzcrReligion.value[x].coding:origFhir.display
                                          Definition

                                          A representation of the meaning of the code in the system, following the rules of the system.

                                          ShortRepresentation defined by the system
                                          Control10..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          284. Patient.extension:nzcrReligion.value[x].coding:origFhir.userSelected
                                          Definition

                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                          ShortIf this coding was chosen directly by the user
                                          Comments

                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                          Control0..01
                                          Typeboolean
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          286. Patient.extension:nzcrReligion.value[x].coding:rawSource
                                          Slice NamerawSource
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control10..1*
                                          TypeCoding
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          288. Patient.extension:nzcrReligion.value[x].coding:rawSource.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control10..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Fixed Valuehttps://standards.digital.health.nz/ns/central-region/patient-religion
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          290. Patient.extension:nzcrReligion.value[x].coding:rawSource.version
                                          Definition

                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                          ShortVersion of the system - if relevant
                                          Comments

                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                          Control0..01
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          292. Patient.extension:nzcrReligion.value[x].coding:rawSource.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control10..1
                                          BindingThe codes SHALL be taken from For codes, see NZ Central Region - Combined Religion Value Set
                                          (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion)
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          294. Patient.extension:nzcrReligion.value[x].coding:rawSource.display
                                          Definition

                                          A representation of the meaning of the code in the system, following the rules of the system.

                                          ShortRepresentation defined by the system
                                          Control10..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          296. Patient.extension:nzcrReligion.value[x].coding:rawSource.userSelected
                                          Definition

                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                          ShortIf this coding was chosen directly by the user
                                          Comments

                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                          Control0..01
                                          Typeboolean
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          298. Patient.extension:nzcrReligion.value[x].text
                                          Definition

                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                          ShortPlain text representation of the concept
                                          Comments

                                          Very often the text is the same as a displayName of one of the codings.

                                          Control0..01
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          300. Patient.extension:interpreterRequired
                                          Slice NameinterpreterRequired
                                          Definition

                                          This Patient requires an interpreter to communicate healthcare information to the practitioner.

                                          ShortWhether the patient needs an interpreter
                                          Comments

                                          The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.

                                          Control0..1
                                          TypeExtension(Patient Interpreter Required) (Extension Type: boolean)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          302. Patient.extension:interpreterRequired.extension
                                          Definition

                                          An Extension


                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                          ShortExtensionAdditional content defined by implementations
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                          Control0..0*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 304. Patient.extension:interpreterRequired.url
                                            Definition

                                            Source of the definition for the extension code - a logical name or a URL.

                                            Shortidentifies the meaning of the extension
                                            Comments

                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
                                            306. Patient.extension:interpreterRequired.value[x]
                                            Definition

                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                            ShortValue of extension
                                            Control10..1
                                            This element is affected by the following invariants: ext-1
                                            Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            308. Patient.modifierExtension
                                            Definition

                                            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                            ShortExtensions that cannot be ignored
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                            Summaryfalse
                                            Requirements

                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                            Alternate Namesextensions, user content
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            310. Patient.identifier
                                            Definition

                                            An identifier for this patient.

                                            ShortAn identifier for this patient
                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control10..*
                                            TypeIdentifier
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

                                            Patients are almost always assigned specific numerical identifiers.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ system
                                            • 312. Patient.identifier.id
                                              Definition

                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              ShortUnique id for inter-element referencing
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              314. Patient.identifier.extension
                                              Definition

                                              An Extension


                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                              ShortExtensionAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..0*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 316. Patient.identifier.use
                                                Definition

                                                The purpose of this identifier.

                                                Shortusual | official | temp | secondary | old (If known)
                                                Comments

                                                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                Control10..1
                                                BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                Identifies the purpose for this identifier, if known .

                                                Typecode
                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                318. Patient.identifier.type
                                                Definition

                                                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                ShortDescription of identifier
                                                Comments

                                                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                Control10..1
                                                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                                                (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Allows users to make use of identifiers when the identifier system is not known.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                320. Patient.identifier.type.coding
                                                Definition

                                                A reference to a code defined by a terminology system.

                                                ShortCode defined by a terminology system
                                                Comments

                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                Control0..*
                                                TypeCoding
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Allows for alternative encodings within a code system, and translations to other code systems.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                322. Patient.identifier.type.coding.system
                                                Definition

                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                ShortIdentity of the terminology system
                                                Comments

                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                Control10..1
                                                Typeuri
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Need to be unambiguous about the source of the definition of the symbol.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                324. Patient.identifier.type.coding.code
                                                Definition

                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                ShortSymbol in syntax defined by the system
                                                Control10..1
                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Need to refer to a particular code in the system.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                326. Patient.identifier.type.coding.display
                                                Definition

                                                A representation of the meaning of the code in the system, following the rules of the system.

                                                ShortRepresentation defined by the system
                                                Control10..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                328. Patient.identifier.system
                                                Definition

                                                Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                ShortThe namespace for the identifier value
                                                Comments

                                                Identifier.system is always case sensitive.

                                                Control10..1
                                                Typeuri
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                330. Patient.identifier.value
                                                Definition

                                                The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                ShortThe value that is unique
                                                Comments

                                                If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                Control10..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Example<br/><b>General</b>:123456
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                332. Patient.identifier.period
                                                Definition

                                                Time period during which identifier is/was valid for use.

                                                ShortTime period when id is/was valid for use
                                                Control0..01
                                                TypePeriod
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                334. Patient.identifier.assigner
                                                Definition

                                                Organization that issued/manages the identifier.

                                                ShortOrganization that issued id (may be just text)
                                                Comments

                                                The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                Control0..01
                                                TypeReference(Organization)
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                336. Patient.identifier:NHI
                                                Slice NameNHI
                                                Definition

                                                An identifier for this patient.

                                                ShortAn identifier for this patient
                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..*
                                                TypeIdentifier
                                                Is Modifierfalse
                                                Summarytrue
                                                Requirements

                                                Patients are almost always assigned specific numerical identifiers.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                338. Patient.identifier:NHI.id
                                                Definition

                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                ShortUnique id for inter-element referencing
                                                Control0..01
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                340. Patient.identifier:NHI.extension
                                                Definition

                                                An Extension


                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                ShortExtensionAdditional content defined by implementations
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..0*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 342. Patient.identifier:NHI.use
                                                  Definition

                                                  The purpose of this identifier.

                                                  Shortusual | official | temp | secondary | old (If known)
                                                  Comments

                                                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                  Control10..1
                                                  BindingThe codes SHALL be taken from Valid use values for NHIhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code)
                                                  Typecode
                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Requirements

                                                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  344. Patient.identifier:NHI.type
                                                  Definition

                                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                  ShortDescription of identifier
                                                  Comments

                                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                  Control10..1
                                                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                                                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Requirements

                                                  Allows users to make use of identifiers when the identifier system is not known.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  346. Patient.identifier:NHI.system
                                                  Definition

                                                  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                  ShortThe namespace for the identifier value
                                                  Comments

                                                  Identifier.system is always case sensitive.

                                                  Control10..1
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Requirements

                                                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                  Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
                                                  Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  348. Patient.identifier:NHI.value
                                                  Definition

                                                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                  ShortThe value that is unique
                                                  Comments

                                                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                  Control10..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Example<br/><b>General</b>:123456
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  350. Patient.identifier:NHI.period
                                                  Definition

                                                  Time period during which identifier is/was valid for use.

                                                  ShortTime period when id is/was valid for use
                                                  Control0..01
                                                  TypePeriod
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  352. Patient.identifier:NHI.assigner
                                                  Definition

                                                  Organization that issued/manages the identifier.

                                                  ShortOrganization that issued id (may be just text)
                                                  Comments

                                                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                  Control0..01
                                                  TypeReference(Organization)
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  354. Patient.active
                                                  Definition

                                                  Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                                  It is often used to filter patient lists to exclude inactive patients

                                                  Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                                  ShortWhether this patient's record is in active use
                                                  Comments

                                                  If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                                  Control0..1
                                                  Typeboolean
                                                  Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Need to be able to mark a patient record as not to be used because it was created in error.

                                                  Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  356. Patient.name
                                                  Definition

                                                  A name associated with the individual.

                                                  ShortA name associated with the patient
                                                  Comments

                                                  A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                  Control10..*
                                                  TypeHumanName
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Requirements

                                                  Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  358. Patient.name.id
                                                  Definition

                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..01
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  360. Patient.name.extension
                                                  Definition

                                                  An Extension


                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                  ShortExtensionAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..0*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 362. Patient.name.use
                                                    Definition

                                                    Identifies the purpose for this name.

                                                    Shortone of: usual / oldusual | official | temp | nickname | anonymous | old | maiden
                                                    Comments

                                                    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                    Control10..1
                                                    BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                                                    (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                    The use of a human name.

                                                    Typecode
                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Requirements

                                                    Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    364. Patient.name.text
                                                    Definition

                                                    Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                    ShortText representation of the full name
                                                    Comments

                                                    Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                    Control10..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Requirements

                                                    A renderable, unencoded form.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    366. Patient.name.family
                                                    Definition

                                                    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                    ShortFamily name (often called 'Surname')
                                                    Comments

                                                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                    Control10..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Alternate Namessurname
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    368. Patient.name.given
                                                    Definition

                                                    Given name.

                                                    ShortGiven names (not always 'first'). Includes middle names
                                                    Comments

                                                    If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                    Control0..*
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Alternate Namesfirst name, middle name
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    370. Patient.name.prefix
                                                    Definition

                                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                    ShortParts that come before the name
                                                    Control0..*
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    372. Patient.name.suffix
                                                    Definition

                                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                    ShortParts that come after the name
                                                    Control0..0*
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    374. Patient.telecom
                                                    Definition

                                                    Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


                                                    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                    ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)A contact detail for the individual
                                                    Comments

                                                    A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                    Control0..*
                                                    This element is affected by the following invariants: ele-1
                                                    TypeContactPoint(Common NZ ContactPoint datatype)
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Requirements

                                                    People have (primary) ways to contact them in some way such as phone, email.

                                                    Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                                                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    376. Patient.telecom.id
                                                    Definition

                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                    ShortUnique id for inter-element referencing
                                                    Control0..01
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    378. Patient.telecom.extension
                                                    Definition

                                                    An Extension


                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                    ShortExtensionAdditional content defined by implementations
                                                    Comments

                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                    Control0..0*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 380. Patient.telecom.extension:cp-purpose
                                                      Slice Namecp-purpose
                                                      Definition

                                                      A specific purpose for which this ContactPoint dataType would be used. An example would be to indicate that this ContactPoint is used for video conferencing.

                                                      ShortA specific purpose for which this ContactPoint dataType would be used
                                                      Control0..0
                                                      TypeExtension(A specific purpose for which this ContactPoint dataType would be used) (Extension Type: CodeableConcept)
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      382. Patient.telecom.system
                                                      Definition

                                                      Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                      Shortphone | fax | email | pager | url | sms | other
                                                      Control10..1
                                                      This element is affected by the following invariants: cpt-2
                                                      BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                                                      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                      Telecommunications form for contact point.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      384. Patient.telecom.value
                                                      Definition

                                                      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                      ShortThe actual contact point details
                                                      Comments

                                                      Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                      Control10..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

                                                      Need to support legacy numbers that are not in a tightly controlled format.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      386. Patient.telecom.use
                                                      Definition

                                                      Identifies the purpose for the contact point.

                                                      Shorthome | work | temp | old | mobile - purpose of this contact point
                                                      Comments

                                                      Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                      Control10..1
                                                      BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                                      (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                      Use of contact point.

                                                      Typecode
                                                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

                                                      Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      388. Patient.telecom.rank
                                                      Definition

                                                      Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                      ShortSpecify preferred order of use (1 = highest)
                                                      Comments

                                                      Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                      Control0..01
                                                      TypepositiveInt
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      390. Patient.telecom.period
                                                      Definition

                                                      Time period when the contact point was/is in use.

                                                      ShortTime period when the contact point was/is in use
                                                      Control0..01
                                                      TypePeriod
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      392. Patient.gender
                                                      Definition

                                                      Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                                                      Shortmale | female | other | unknown
                                                      Comments

                                                      The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                      Control10..1
                                                      BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
                                                      (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                      The gender of a person used for administrative purposes.

                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

                                                      Needed for identification of the individual, in combination with (at least) name and birth date.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      394. Patient.birthDate
                                                      Definition

                                                      The date of birth for the individual.

                                                      ShortThe date of birth for the individual
                                                      Comments

                                                      At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                                                      Control10..1
                                                      Typedate
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

                                                      Age of the individual drives many clinical processes.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      LOINC Code21112-8
                                                      396. Patient.deceased[x]
                                                      Definition

                                                      Indicates if the individual is deceased or not.

                                                      ShortdeceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if knownIndicates if the individual is deceased or not
                                                      Comments

                                                      If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                      Control10..1
                                                      TypeChoice of: boolean, dateTime
                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Must Support TypesNo must-support rules about the choice of types/profiles
                                                      Summarytrue
                                                      Requirements

                                                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                      • type @ $this
                                                      • 398. Patient.deceased[x]:deceasedDateTime
                                                        Slice NamedeceasedDateTime
                                                        Definition

                                                        Indicates if the individual is deceased or not.

                                                        ShortIndicates if the individual is deceased or not
                                                        Comments

                                                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                        Control0..1
                                                        TypedateTime, boolean
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Requirements

                                                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        400. Patient.deceased[x]:deceasedBoolean
                                                        Slice NamedeceasedBoolean
                                                        Definition

                                                        Indicates if the individual is deceased or not.

                                                        ShortIndicates if the individual is deceased or not
                                                        Comments

                                                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                        Control0..1
                                                        Typeboolean, dateTime
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Requirements

                                                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        402. Patient.address
                                                        Definition

                                                        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


                                                        An address for the individual.

                                                        ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the individual
                                                        Comments

                                                        Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


                                                        Patient may have multiple addresses with different uses or applicable periods.

                                                        Control0..*
                                                        This element is affected by the following invariants: ele-1
                                                        TypeAddress(Common NZ Address datatype)
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Requirements

                                                        May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        404. Patient.address.id
                                                        Definition

                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                        ShortUnique id for inter-element referencing
                                                        Control0..01
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        406. Patient.address.extension:nz-geocode
                                                        Slice Namenz-geocode
                                                        Definition

                                                        New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

                                                        ShortNZ Geocode
                                                        Control0..0
                                                        TypeExtension(NZ Geocode) (Complex Extension)
                                                        Is Modifierfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        408. Patient.address.extension:suburb
                                                        Slice Namesuburb
                                                        Definition

                                                        Suburb element of a NZ Address.

                                                        ShortNZ Suburb
                                                        Control0..1
                                                        TypeExtension(NZ Suburb) (Extension Type: string)
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        410. Patient.address.extension:suburb.extension
                                                        Definition

                                                        An Extension


                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                        ShortExtensionAdditional content defined by implementations
                                                        Comments

                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                        Control0..0*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        SlicingThis element introduces a set of slices on Patient.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 412. Patient.address.extension:suburb.url
                                                          Definition

                                                          Source of the definition for the extension code - a logical name or a URL.

                                                          Shortidentifies the meaning of the extension
                                                          Comments

                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                          Control1..1
                                                          Typeuri
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/suburb
                                                          414. Patient.address.extension:suburb.value[x]
                                                          Definition

                                                          NZ Suburbs


                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                          ShortNZSuburbValue of extension
                                                          Comments

                                                          NZ Suburbs are defined in the NZ Electronic Street Address Mapping (eSAM) standard.

                                                          Control0..1
                                                          Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summaryfalse
                                                          LabelNZ Suburb
                                                          Example<br/><b>Rototuna</b>:Rototuna
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          416. Patient.address.extension:building-name
                                                          Slice Namebuilding-name
                                                          Definition

                                                          The name of a building cited in an address.

                                                          ShortBuilding Name
                                                          Control0..0
                                                          TypeExtension(Building Name) (Extension Type: string)
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          418. Patient.address.extension:domicile-code
                                                          Slice Namedomicile-code
                                                          Definition

                                                          NZ Domicile Code. Derived from a patient's primary physical, home address.

                                                          ShortNZ Domicile Code
                                                          Control0..1
                                                          TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          420. Patient.address.extension:domicile-code.id
                                                          Definition

                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                          ShortUnique id for inter-element referencing
                                                          Control0..01
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          422. Patient.address.extension:domicile-code.extension
                                                          Definition

                                                          An Extension


                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                          ShortExtensionAdditional content defined by implementations
                                                          Comments

                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                          Control0..0*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Alternate Namesextensions, user content
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          SlicingThis element introduces a set of slices on Patient.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 424. Patient.address.extension:domicile-code.url
                                                            Definition

                                                            Source of the definition for the extension code - a logical name or a URL.

                                                            Shortidentifies the meaning of the extension
                                                            Comments

                                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                            Control1..1
                                                            Typeuri
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/domicile-code
                                                            426. Patient.address.extension:domicile-code.value[x]
                                                            Definition

                                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                            ShortValue of extension
                                                            Control0..1
                                                            TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            SlicingThis element introduces a set of slices on Patient.address.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                            • type @ $this
                                                            • 428. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept
                                                              Slice NamevalueCodeableConcept
                                                              Definition

                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                              ShortValue of extension
                                                              Control0..1
                                                              BindingThe codes SHOULD be taken from For codes, see Domicile Code
                                                              (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code)
                                                              TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              430. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding
                                                              Definition

                                                              A reference to a code defined by a terminology system.

                                                              ShortCode defined by a terminology system
                                                              Comments

                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                              Control10..1*
                                                              TypeCoding
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              Allows for alternative encodings within a code system, and translations to other code systems.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              432. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.system
                                                              Definition

                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                              ShortIdentity of the terminology system
                                                              Comments

                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                              Control10..1
                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              434. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.version
                                                              Definition

                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                              ShortVersion of the system - if relevant
                                                              Comments

                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                              Control0..01
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              436. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.code
                                                              Definition

                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                              ShortSymbol in syntax defined by the system
                                                              Control10..1
                                                              Typecode
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              Need to refer to a particular code in the system.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              438. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.display
                                                              Definition

                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                              ShortRepresentation defined by the system
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              440. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected
                                                              Definition

                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                              ShortIf this coding was chosen directly by the user
                                                              Comments

                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                              Control0..01
                                                              Typeboolean
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              442. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.text
                                                              Definition

                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                              ShortPlain text representation of the concept
                                                              Comments

                                                              Very often the text is the same as a displayName of one of the codings.

                                                              Control0..01
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              444. Patient.address.use
                                                              Definition

                                                              The purpose of this address.

                                                              Shorthome | work | temp | old | billing - purpose of this address
                                                              Comments

                                                              Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                              Control10..1
                                                              BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                                                              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                              The use of an address.

                                                              Typecode
                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              Allows an appropriate address to be chosen from a list of many.

                                                              Example<br/><b>General</b>:home
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              446. Patient.address.type
                                                              Definition

                                                              Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                              ShortPHYSICAL | POSTALpostal | physical | both
                                                              Comments

                                                              The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


                                                              The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                              Control10..1
                                                              BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
                                                              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                              The type of an address (physical / postal).

                                                              Typecode
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Example<br/><b>General</b>:both
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              448. Patient.address.text
                                                              Definition

                                                              Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                              ShortText representation of the address
                                                              Comments

                                                              Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                              Control0..01
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              A renderable, unencoded form.

                                                              Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              450. Patient.address.line
                                                              Definition

                                                              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                              ShortStreet name, number, direction & P.O. Box etc.
                                                              Control0..2*
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Example<br/><b>General</b>:137 Nowhere Street
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              452. Patient.address.city
                                                              Definition

                                                              The name of the city, town, suburb, village or other community or delivery center.

                                                              ShortName of city, town etc.
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Alternate NamesMunicpality
                                                              Example<br/><b>General</b>:Erewhon
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              454. Patient.address.district
                                                              Definition

                                                              The name of the administrative area (county).

                                                              ShortDistrict name (aka county)
                                                              Comments

                                                              District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                              Control0..01
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Alternate NamesCounty
                                                              Example<br/><b>General</b>:Madison
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              456. Patient.address.state
                                                              Definition

                                                              Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                              ShortSub-unit of country (abbreviations ok)
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Alternate NamesProvince, Territory
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              458. Patient.address.postalCode
                                                              Definition

                                                              A postal code designating a region defined by the postal service.

                                                              ShortPostal code for area
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Alternate NamesZip
                                                              Example<br/><b>General</b>:9132
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              460. Patient.address.country
                                                              Definition

                                                              Country - a nation as commonly understood or generally accepted.

                                                              ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                              Comments

                                                              ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              462. Patient.address.period
                                                              Definition

                                                              Time period when address was/is in use.

                                                              ShortTime period when address was/is in use
                                                              Control0..01
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Requirements

                                                              Allows addresses to be placed in historical context.

                                                              Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              464. Patient.maritalStatus
                                                              Definition

                                                              This field contains a patient's most recent marital (civil) status.

                                                              ShortMarital (civil) status of a patient
                                                              Control10..1
                                                              BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from NZ Central Region - Marital Status Value Sethttp://hl7.org/fhir/ValueSet/marital-status
                                                              (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status)
                                                              TypeCodeableConcept
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Summaryfalse
                                                              Requirements

                                                              Most, if not all systems capture it.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              466. Patient.maritalStatus.id
                                                              Definition

                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                              ShortUnique id for inter-element referencing
                                                              Control0..01
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              468. Patient.maritalStatus.extension
                                                              Definition

                                                              An Extension


                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                              ShortExtensionAdditional content defined by implementations
                                                              Comments

                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                              Control0..0*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Alternate Namesextensions, user content
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on Patient.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 470. Patient.maritalStatus.coding
                                                                Definition

                                                                A reference to a code defined by a terminology system.

                                                                ShortCode defined by a terminology system
                                                                Comments

                                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                Control10..*
                                                                TypeCoding
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Summarytrue
                                                                Requirements

                                                                Allows for alternative encodings within a code system, and translations to other code systems.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                472. Patient.maritalStatus.coding.id
                                                                Definition

                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                ShortUnique id for inter-element referencing
                                                                Control0..01
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                474. Patient.maritalStatus.coding.extension
                                                                Definition

                                                                An Extension


                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                ShortExtensionAdditional content defined by implementations
                                                                Comments

                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                Control0..0*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Alternate Namesextensions, user content
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on Patient.maritalStatus.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 476. Patient.maritalStatus.coding.system
                                                                  Definition

                                                                  The identification of the code system that defines the meaning of the symbol in the code.

                                                                  ShortIdentity of the terminology system
                                                                  Comments

                                                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                  Control10..1
                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  Requirements

                                                                  Need to be unambiguous about the source of the definition of the symbol.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  478. Patient.maritalStatus.coding.version
                                                                  Definition

                                                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                  ShortVersion of the system - if relevant
                                                                  Comments

                                                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                  Control0..01
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  480. Patient.maritalStatus.coding.code
                                                                  Definition

                                                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                  ShortSymbol in syntax defined by the system
                                                                  Control10..1
                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  Requirements

                                                                  Need to refer to a particular code in the system.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  482. Patient.maritalStatus.coding.display
                                                                  Definition

                                                                  A representation of the meaning of the code in the system, following the rules of the system.

                                                                  ShortRepresentation defined by the system
                                                                  Control10..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  Requirements

                                                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  484. Patient.maritalStatus.coding.userSelected
                                                                  Definition

                                                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                  ShortIf this coding was chosen directly by the user
                                                                  Comments

                                                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                  Control0..01
                                                                  Typeboolean
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  486. Patient.maritalStatus.text
                                                                  Definition

                                                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                  ShortPlain text representation of the concept
                                                                  Comments

                                                                  Very often the text is the same as a displayName of one of the codings.

                                                                  Control0..01
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  488. Patient.multipleBirth[x]
                                                                  Definition

                                                                  Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                  ShortWhether patient is part of a multiple birth
                                                                  Comments

                                                                  Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                  Control0..01
                                                                  TypeChoice of: boolean, integer
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summaryfalse
                                                                  Requirements

                                                                  For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  490. Patient.photo
                                                                  Definition

                                                                  Image of the patient.

                                                                  ShortImage of the patient
                                                                  Comments

                                                                  Guidelines:

                                                                  • Use id photos, not clinical photos.
                                                                  • Limit dimensions to thumbnail.
                                                                  • Keep byte count low to ease resource updates.
                                                                  Control0..0*
                                                                  TypeAttachment
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  492. Patient.contact
                                                                  Definition

                                                                  A contact party (e.g. guardian, partner, friend) for the patient.

                                                                  ShortA contact party (e.g. guardian, partner, friend) for the patient
                                                                  Comments

                                                                  Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                  Control0..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Need to track people you can contact about the patient.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                  pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                  494. Patient.contact.id
                                                                  Definition

                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..01
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  496. Patient.contact.extension
                                                                  Definition

                                                                  An Extension


                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                  ShortExtensionAdditional content defined by implementations
                                                                  Comments

                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                  Control0..0*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  498. Patient.contact.modifierExtension
                                                                  Definition

                                                                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                  Comments

                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                  Summarytrue
                                                                  Requirements

                                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                  Alternate Namesextensions, user content, modifiers
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  500. Patient.contact.relationship
                                                                  Definition

                                                                  The nature of the relationship between the patient and the contact person.

                                                                  ShortThe kind of relationship
                                                                  Control10..1*
                                                                  BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship
                                                                  (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                  The nature of the relationship between a patient and a contact person for that patient.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summaryfalse
                                                                  Requirements

                                                                  Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  502. Patient.contact.relationship.id
                                                                  Definition

                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..01
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  504. Patient.contact.relationship.extension:contact-relationship
                                                                  Slice Namecontact-relationship
                                                                  Definition

                                                                  Coding extension recording the original contact relationship value from NK1-HL7 v2 message that was used to create / update the FHIR resource

                                                                  ShortContact Relationship
                                                                  Control0..1
                                                                  TypeExtension(Contact Relationship) (Extension Type: Coding)
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  506. Patient.contact.relationship.extension:contact-relationship.extension
                                                                  Definition

                                                                  An Extension


                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                  ShortExtensionAdditional content defined by implementations
                                                                  Comments

                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                  Control0..0*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  SlicingThis element introduces a set of slices on Patient.contact.relationship.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 508. Patient.contact.relationship.extension:contact-relationship.url
                                                                    Definition

                                                                    Source of the definition for the extension code - a logical name or a URL.

                                                                    Shortidentifies the meaning of the extension
                                                                    Comments

                                                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                    Control1..1
                                                                    Typeuri
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    Fixed Valuehttps://standards.digital.health.nz/fhir/central-region/extn-contact-relationship
                                                                    510. Patient.contact.relationship.coding
                                                                    Definition

                                                                    A reference to a code defined by a terminology system.

                                                                    ShortCode defined by a terminology system
                                                                    Comments

                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                    Control0..*
                                                                    TypeCoding
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    512. Patient.contact.relationship.coding.id
                                                                    Definition

                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..01
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    514. Patient.contact.relationship.coding.extension
                                                                    Definition

                                                                    An Extension


                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                    ShortExtensionAdditional content defined by implementations
                                                                    Comments

                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                    Control0..0*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Alternate Namesextensions, user content
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    SlicingThis element introduces a set of slices on Patient.contact.relationship.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 516. Patient.contact.relationship.coding.system
                                                                      Definition

                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                      ShortIdentity of the terminology system
                                                                      Comments

                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                      Control10..1
                                                                      Typeuri
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Requirements

                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      518. Patient.contact.relationship.coding.version
                                                                      Definition

                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                      ShortVersion of the system - if relevant
                                                                      Comments

                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                      Control0..01
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      520. Patient.contact.relationship.coding.code
                                                                      Definition

                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                      ShortSymbol in syntax defined by the system
                                                                      Control10..1
                                                                      Typecode
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Requirements

                                                                      Need to refer to a particular code in the system.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      522. Patient.contact.relationship.coding.display
                                                                      Definition

                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                      ShortRepresentation defined by the system
                                                                      Control10..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Requirements

                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      524. Patient.contact.relationship.coding.userSelected
                                                                      Definition

                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                      ShortIf this coding was chosen directly by the user
                                                                      Comments

                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                      Control0..01
                                                                      Typeboolean
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Requirements

                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      526. Patient.contact.relationship.text
                                                                      Definition

                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                      ShortPlain text representation of the concept
                                                                      Comments

                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                      Control0..01
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Requirements

                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      528. Patient.contact.name
                                                                      Definition

                                                                      A name associated with the contact person.

                                                                      ShortA name associated with the contact person
                                                                      Control10..1
                                                                      TypeHumanName
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      530. Patient.contact.name.id
                                                                      Definition

                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..01
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      532. Patient.contact.name.extension
                                                                      Definition

                                                                      An Extension


                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                      ShortExtensionAdditional content defined by implementations
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..0*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on Patient.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 534. Patient.contact.name.use
                                                                        Definition

                                                                        Identifies the purpose for this name.

                                                                        Shortusual | official | temp | nickname | anonymous | old | maiden
                                                                        Comments

                                                                        Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                        Control0..01
                                                                        BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                                                                        (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                                        The use of a human name.

                                                                        Typecode
                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Requirements

                                                                        Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        536. Patient.contact.name.text
                                                                        Definition

                                                                        Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                        ShortText representation of the full name
                                                                        Comments

                                                                        Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                        Control10..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Summarytrue
                                                                        Requirements

                                                                        A renderable, unencoded form.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        538. Patient.contact.name.family
                                                                        Definition

                                                                        The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                        ShortFamily name (often called 'Surname')
                                                                        Comments

                                                                        Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                        Control10..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Summarytrue
                                                                        Alternate Namessurname
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        540. Patient.contact.name.given
                                                                        Definition

                                                                        Given name.

                                                                        ShortGiven names (not always 'first'). Includes middle names
                                                                        Comments

                                                                        If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                        Control0..*
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Summarytrue
                                                                        Alternate Namesfirst name, middle name
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        542. Patient.contact.name.prefix
                                                                        Definition

                                                                        Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                        ShortParts that come before the name
                                                                        Control0..1*
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        544. Patient.contact.name.suffix
                                                                        Definition

                                                                        Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                        ShortParts that come after the name
                                                                        Control0..0*
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        546. Patient.contact.telecom
                                                                        Definition

                                                                        A contact detail for the person, e.g. a telephone number or an email address.

                                                                        ShortA contact detail for the person
                                                                        Comments

                                                                        Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                        Control0..*
                                                                        TypeContactPoint
                                                                        Is Modifierfalse
                                                                        Must Supporttrue
                                                                        Summaryfalse
                                                                        Requirements

                                                                        People have (primary) ways to contact them in some way such as phone, email.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        548. Patient.contact.telecom.id
                                                                        Definition

                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..01
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        550. Patient.contact.telecom.extension
                                                                        Definition

                                                                        An Extension


                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                        ShortExtensionAdditional content defined by implementations
                                                                        Comments

                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                        Control0..0*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Alternate Namesextensions, user content
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on Patient.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 552. Patient.contact.telecom.system
                                                                          Definition

                                                                          Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                          Shortphone | fax | email | pager | url | sms | other
                                                                          Control10..1
                                                                          This element is affected by the following invariants: cpt-2
                                                                          BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                                                                          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                          Telecommunications form for contact point.

                                                                          Typecode
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          554. Patient.contact.telecom.value
                                                                          Definition

                                                                          The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                          ShortThe actual contact point details
                                                                          Comments

                                                                          Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                                          Control10..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Summarytrue
                                                                          Requirements

                                                                          Need to support legacy numbers that are not in a tightly controlled format.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          556. Patient.contact.telecom.use
                                                                          Definition

                                                                          Identifies the purpose for the contact point.

                                                                          Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                          Comments

                                                                          Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                          Control10..1
                                                                          BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                                                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                                          Use of contact point.

                                                                          Typecode
                                                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Summarytrue
                                                                          Requirements

                                                                          Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          558. Patient.contact.telecom.rank
                                                                          Definition

                                                                          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                          ShortSpecify preferred order of use (1 = highest)
                                                                          Comments

                                                                          Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                          Control0..01
                                                                          TypepositiveInt
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          560. Patient.contact.address
                                                                          Definition

                                                                          Address for the contact person.

                                                                          ShortAddress for the contact person
                                                                          Control0..01
                                                                          TypeAddress
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Requirements

                                                                          Need to keep track where the contact person can be contacted per postal mail or visited.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          562. Patient.contact.gender
                                                                          Definition

                                                                          Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                          Shortmale | female | other | unknown
                                                                          Control0..01
                                                                          BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
                                                                          (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                          The gender of a person used for administrative purposes.

                                                                          Typecode
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summaryfalse
                                                                          Requirements

                                                                          Needed to address the person correctly.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          564. Patient.contact.organization
                                                                          Definition

                                                                          Organization on behalf of which the contact is acting or for which the contact is working.

                                                                          ShortOrganization that is associated with the contact
                                                                          Control0..01
                                                                          This element is affected by the following invariants: pat-1
                                                                          TypeReference(Organization)
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Requirements

                                                                          For guardians or business related contacts, the organization is relevant.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          566. Patient.contact.period
                                                                          Definition

                                                                          The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                          ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                          Control0..1
                                                                          TypePeriod
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          568. Patient.communication
                                                                          Definition

                                                                          A language which may be used to communicate with the patient about his or her health.

                                                                          ShortA language which may be used to communicate with the patient about his or her health
                                                                          Comments

                                                                          If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                          Control0..*
                                                                          TypeBackboneElement
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Requirements

                                                                          If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          570. Patient.communication.id
                                                                          Definition

                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..01
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          572. Patient.communication.extension
                                                                          Definition

                                                                          An Extension


                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                          ShortExtensionAdditional content defined by implementations
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..0*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          574. Patient.communication.modifierExtension
                                                                          Definition

                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                          Summarytrue
                                                                          Requirements

                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                          Alternate Namesextensions, user content, modifiers
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          576. Patient.communication.language
                                                                          Definition

                                                                          The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                                                                          ShortThe language which can be used to communicate with the patient about his or her health
                                                                          Comments

                                                                          The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                                                                          Control1..1
                                                                          BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
                                                                          (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                                          A human language.

                                                                          Additional BindingsPurpose
                                                                          AllLanguagesMax Binding
                                                                          NZ Central Region - Raw Language Value Value SetRequired
                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Requirements

                                                                          Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          578. Patient.communication.language.id
                                                                          Definition

                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..01
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          580. Patient.communication.language.extension
                                                                          Definition

                                                                          An Extension


                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                          ShortExtensionAdditional content defined by implementations
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..0*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          SlicingThis element introduces a set of slices on Patient.communication.language.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 582. Patient.communication.language.coding
                                                                            Definition

                                                                            A reference to a code defined by a terminology system.

                                                                            ShortCode defined by a terminology system
                                                                            Comments

                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                            Control0..*
                                                                            TypeCoding
                                                                            Is Modifierfalse
                                                                            Summarytrue
                                                                            Requirements

                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            584. Patient.communication.language.coding.id
                                                                            Definition

                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..01
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            586. Patient.communication.language.coding.extension
                                                                            Definition

                                                                            An Extension


                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                            ShortExtensionAdditional content defined by implementations
                                                                            Comments

                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                            Control0..0*
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            SlicingThis element introduces a set of slices on Patient.communication.language.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 588. Patient.communication.language.coding.system
                                                                              Definition

                                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                                              ShortIdentity of the terminology system
                                                                              Comments

                                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                              Control0..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supporttrue
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              590. Patient.communication.language.coding.version
                                                                              Definition

                                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                              ShortVersion of the system - if relevant
                                                                              Comments

                                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                              Control0..01
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              592. Patient.communication.language.coding.code
                                                                              Definition

                                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                              ShortSymbol in syntax defined by the system
                                                                              Control0..1
                                                                              Typecode
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supporttrue
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to refer to a particular code in the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              594. Patient.communication.language.coding.display
                                                                              Definition

                                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                                              ShortRepresentation defined by the system
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supporttrue
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              596. Patient.communication.language.coding.userSelected
                                                                              Definition

                                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                              ShortIf this coding was chosen directly by the user
                                                                              Comments

                                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                              Control0..01
                                                                              Typeboolean
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              598. Patient.communication.preferred
                                                                              Definition

                                                                              Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                              ShortLanguage preference indicator
                                                                              Comments

                                                                              This language is specifically identified for communicating healthcare information.

                                                                              Control0..1
                                                                              Typeboolean
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Requirements

                                                                              People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              600. Patient.generalPractitioner
                                                                              Definition

                                                                              Patient's nominated care provider.

                                                                              ShortPatient's nominated primary care provider
                                                                              Comments

                                                                              This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                                                              Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                                                              Control0..1*
                                                                              TypeReference(Organization, Practitioner, PractitionerRole)
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                                                              Summaryfalse
                                                                              Alternate NamescareProvider
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              602. Patient.generalPractitioner.id
                                                                              Definition

                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..01
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              604. Patient.generalPractitioner.extension
                                                                              Definition

                                                                              An Extension


                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                              ShortExtensionAdditional content defined by implementations
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                              Control0..0*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on Patient.generalPractitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 606. Patient.generalPractitioner.reference
                                                                                Definition

                                                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                                ShortLiteral reference, Relative, internal or absolute URL
                                                                                Comments

                                                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                                Control0..1
                                                                                This element is affected by the following invariants: ref-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supporttrue
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                608. Patient.generalPractitioner.type
                                                                                Definition

                                                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                ShortType the reference refers to (e.g. "Patient")
                                                                                Comments

                                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                Control10..1
                                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                                                Aa resource (or, for logical models, the URI of the logical model).

                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supporttrue
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                610. Patient.generalPractitioner.identifier
                                                                                Definition

                                                                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                                ShortLogical reference, when literal reference is not known
                                                                                Comments

                                                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                Control10..1
                                                                                TypeIdentifier
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                612. Patient.generalPractitioner.identifier.id
                                                                                Definition

                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..01
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                614. Patient.generalPractitioner.identifier.extension
                                                                                Definition

                                                                                An Extension


                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                ShortExtensionAdditional content defined by implementations
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                Control0..0*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                SlicingThis element introduces a set of slices on Patient.generalPractitioner.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 616. Patient.generalPractitioner.identifier.use
                                                                                  Definition

                                                                                  The purpose of this identifier.

                                                                                  Shortusual | official | temp | secondary | old (If known)
                                                                                  Comments

                                                                                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                  Control10..1
                                                                                  BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                                                                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                  Identifies the purpose for this identifier, if known .

                                                                                  Typecode
                                                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Must Supporttrue
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  618. Patient.generalPractitioner.identifier.type
                                                                                  Definition

                                                                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                  ShortDescription of identifier
                                                                                  Comments

                                                                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                  Control10..1
                                                                                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                                                                                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                                                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                  TypeCodeableConcept
                                                                                  Is Modifierfalse
                                                                                  Must Supporttrue
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Allows users to make use of identifiers when the identifier system is not known.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  620. Patient.generalPractitioner.identifier.type.id
                                                                                  Definition

                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..01
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  622. Patient.generalPractitioner.identifier.type.extension
                                                                                  Definition

                                                                                  An Extension


                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                  ShortExtensionAdditional content defined by implementations
                                                                                  Comments

                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                  Control0..0*
                                                                                  TypeExtension
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Alternate Namesextensions, user content
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  SlicingThis element introduces a set of slices on Patient.generalPractitioner.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 624. Patient.generalPractitioner.identifier.type.coding
                                                                                    Definition

                                                                                    A reference to a code defined by a terminology system.

                                                                                    ShortCode defined by a terminology system
                                                                                    Comments

                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                    Control0..*
                                                                                    TypeCoding
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    626. Patient.generalPractitioner.identifier.type.coding.id
                                                                                    Definition

                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..01
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    628. Patient.generalPractitioner.identifier.type.coding.extension
                                                                                    Definition

                                                                                    An Extension


                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                    ShortExtensionAdditional content defined by implementations
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                    Control0..0*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate Namesextensions, user content
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    SlicingThis element introduces a set of slices on Patient.generalPractitioner.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 630. Patient.generalPractitioner.identifier.type.coding.system
                                                                                      Definition

                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                      ShortIdentity of the terminology system
                                                                                      Comments

                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                      Control10..1
                                                                                      Typeuri
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                      Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      632. Patient.generalPractitioner.identifier.type.coding.version
                                                                                      Definition

                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                      ShortVersion of the system - if relevant
                                                                                      Comments

                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                      Control0..01
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      634. Patient.generalPractitioner.identifier.type.coding.code
                                                                                      Definition

                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                      ShortSymbol in syntax defined by the system
                                                                                      Control10..1
                                                                                      Typecode
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Need to refer to a particular code in the system.

                                                                                      Pattern ValueLR
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      636. Patient.generalPractitioner.identifier.type.coding.display
                                                                                      Definition

                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                      ShortRepresentation defined by the system
                                                                                      Control10..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                      Pattern ValueLocal Registry ID
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      638. Patient.generalPractitioner.identifier.type.coding.userSelected
                                                                                      Definition

                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                      ShortIf this coding was chosen directly by the user
                                                                                      Comments

                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                      Control0..01
                                                                                      Typeboolean
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      640. Patient.generalPractitioner.identifier.type.text
                                                                                      Definition

                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                      ShortPlain text representation of the concept
                                                                                      Comments

                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                      Control0..01
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      642. Patient.generalPractitioner.identifier.system
                                                                                      Definition

                                                                                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                      ShortThe namespace for the identifier value
                                                                                      Comments

                                                                                      Identifier.system is always case sensitive.

                                                                                      Control10..1
                                                                                      Typeuri
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                      Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-practitioner-id
                                                                                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      644. Patient.generalPractitioner.identifier.value
                                                                                      Definition

                                                                                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                      ShortThe value that is unique
                                                                                      Comments

                                                                                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Example<br/><b>General</b>:123456
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      646. Patient.generalPractitioner.identifier.period
                                                                                      Definition

                                                                                      Time period during which identifier is/was valid for use.

                                                                                      ShortTime period when id is/was valid for use
                                                                                      Control0..01
                                                                                      TypePeriod
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      648. Patient.generalPractitioner.identifier.assigner
                                                                                      Definition

                                                                                      Organization that issued/manages the identifier.

                                                                                      ShortOrganization that issued id (may be just text)
                                                                                      Comments

                                                                                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                      Control0..01
                                                                                      TypeReference(Organization)
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      650. Patient.generalPractitioner.display
                                                                                      Definition

                                                                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                      ShortText alternative for the resource
                                                                                      Comments

                                                                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      652. Patient.managingOrganization
                                                                                      Definition

                                                                                      Organization that is the custodian of the patient record.

                                                                                      ShortOrganization that is the custodian of the patient record
                                                                                      Comments

                                                                                      There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                      Control0..01
                                                                                      TypeReference(Organization)
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Need to know who recognizes this patient record, manages and updates it.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      654. Patient.link
                                                                                      Definition

                                                                                      Link to another patient resource that concerns the same actual patient.

                                                                                      ShortLink to another patient resource that concerns the same actual person
                                                                                      Comments

                                                                                      There is no assumption that linked patient records have mutual links.

                                                                                      Control0..*
                                                                                      TypeBackboneElement
                                                                                      Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      There are multiple use cases:

                                                                                      • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                      • Distribution of patient information across multiple servers.
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      656. Patient.link.id
                                                                                      Definition

                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..01
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      658. Patient.link.extension
                                                                                      Definition

                                                                                      An Extension


                                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                      ShortExtensionAdditional content defined by implementations
                                                                                      Comments

                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                      Control0..0*
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Alternate Namesextensions, user content
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      660. Patient.link.modifierExtension
                                                                                      Definition

                                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                      Comments

                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                      Control0..*
                                                                                      TypeExtension
                                                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      662. Patient.link.other
                                                                                      Definition

                                                                                      The other patient resource that the link refers to.

                                                                                      ShortThe other patient or related person resource that the link refers to
                                                                                      Comments

                                                                                      Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                                      Control1..1
                                                                                      TypeReference(Patient, RelatedPerson)
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      664. Patient.link.other.reference
                                                                                      Definition

                                                                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                                      ShortLiteral reference, Relative, internal or absolute URL
                                                                                      Comments

                                                                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                                      Control0..01
                                                                                      This element is affected by the following invariants: ref-1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      666. Patient.link.other.type
                                                                                      Definition

                                                                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                      ShortPatientType the reference refers to (e.g. "Patient")
                                                                                      Comments

                                                                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                      Control0..1
                                                                                      BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                                                                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                                                      Aa resource (or, for logical models, the URI of the logical model).

                                                                                      Typeuri
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Pattern ValuePatient
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      668. Patient.link.other.identifier
                                                                                      Definition

                                                                                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                                      ShortBusiness-level identifier for the Patient being replacedLogical reference, when literal reference is not known
                                                                                      Comments

                                                                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                      Control10..1
                                                                                      TypeIdentifier
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      670. Patient.link.other.display
                                                                                      Definition

                                                                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                      ShortText alternative for the resource
                                                                                      Comments

                                                                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                                      Control0..01
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      672. Patient.link.type
                                                                                      Definition

                                                                                      The type of link between this patient resource and another patient resource.

                                                                                      Shortreplaced-by | replacesreplaced-by | replaces | refer | seealso
                                                                                      Control1..1
                                                                                      BindingThe codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1
                                                                                      (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                                                                      The type of link between this patient resource and another patient resource.

                                                                                      Typecode
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                                                                                      Guidance on how to interpret the contents of this table can be found here

                                                                                      0. Patient
                                                                                      Definition

                                                                                      Demographics and other administrative information about an individual or animal receiving care or other health-related services.

                                                                                      ShortInformation about an individual or animal receiving health care services
                                                                                      Control0..*
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Alternate NamesSubjectOfCare Client Resident
                                                                                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                                                                      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                                                                                      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                                                                                      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                                                                      dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                                                                      nz-pat-1: only a single official NHI (Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2)
                                                                                      2. Patient.id
                                                                                      Definition

                                                                                      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                                                                      ShortLogical id of this artifact
                                                                                      Comments

                                                                                      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                                                                      Control0..1
                                                                                      Typeid
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      4. Patient.meta
                                                                                      Definition

                                                                                      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                                                                      ShortMetadata about the resource
                                                                                      Control0..1
                                                                                      TypeMeta
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      6. Patient.meta.id
                                                                                      Definition

                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      8. Patient.meta.extension
                                                                                      Definition

                                                                                      An Extension

                                                                                      ShortExtension
                                                                                      Control1..*
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      SlicingThis element introduces a set of slices on Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 10. Patient.meta.extension:hl7v2Message
                                                                                        Slice Namehl7v2Message
                                                                                        Definition

                                                                                        Base64 encoded string containing the original HL7 v2 message that was used to create / update the FHIR resource

                                                                                        ShortHL7 v2 Message
                                                                                        Control1..1
                                                                                        TypeExtension(HL7 v2 Message) (Extension Type: base64Binary)
                                                                                        Is Modifierfalse
                                                                                        Must Supporttrue
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        12. Patient.meta.extension:hl7v2Message.id
                                                                                        Definition

                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        14. Patient.meta.extension:hl7v2Message.extension
                                                                                        Definition

                                                                                        An Extension

                                                                                        ShortExtension
                                                                                        Control0..0
                                                                                        TypeExtension
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        SlicingThis element introduces a set of slices on Patient.meta.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 16. Patient.meta.extension:hl7v2Message.url
                                                                                          Definition

                                                                                          Source of the definition for the extension code - a logical name or a URL.

                                                                                          Shortidentifies the meaning of the extension
                                                                                          Comments

                                                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                          Control1..1
                                                                                          Typeuri
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          Fixed Valuehttps://standards.digital.health.nz/ns/central-region/hl7v2-message
                                                                                          18. Patient.meta.extension:hl7v2Message.value[x]
                                                                                          Definition

                                                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                          ShortValue of extension
                                                                                          Control0..1
                                                                                          Typebase64Binary
                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          20. Patient.meta.extension:process-timestamp
                                                                                          Slice Nameprocess-timestamp
                                                                                          Definition

                                                                                          Date and time the source HL7v2 message was translated into FHIR Resource

                                                                                          ShortProcess TimeStamp
                                                                                          Control0..1
                                                                                          TypeExtension(Process TimeStamp) (Extension Type: dateTime)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          22. Patient.meta.extension:source-event-trigger
                                                                                          Slice Namesource-event-trigger
                                                                                          Definition

                                                                                          The HL7v2 message/event trigger that was translated into FHIR Resource (eg A31, I13, etc)

                                                                                          ShortSource Event Trigger
                                                                                          Control0..1
                                                                                          TypeExtension(Source Event Trigger) (Extension Type: CodeableConcept)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          24. Patient.meta.extension:source-record-type
                                                                                          Slice Namesource-record-type
                                                                                          Definition

                                                                                          The HL7v2 record type that was translated into FHIR Resource (eg ADT, REF, etc)

                                                                                          ShortSource Record Type
                                                                                          Control0..1
                                                                                          TypeExtension(Source Record Type) (Extension Type: CodeableConcept)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          26. Patient.meta.extension:source-record-id
                                                                                          Slice Namesource-record-id
                                                                                          Definition

                                                                                          The HL7v2 record ID that was translated into FHIR Resource

                                                                                          ShortSource Record ID
                                                                                          Control0..1
                                                                                          TypeExtension(Source Record ID) (Extension Type: string)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          28. Patient.meta.extension:source-data-mode-version
                                                                                          Slice Namesource-data-mode-version
                                                                                          Definition

                                                                                          The HL7v2 version number for the message/event that was translated into FHIR Resource

                                                                                          ShortSource Data Model Version
                                                                                          Control0..1
                                                                                          TypeExtension(Source Data Model Version) (Extension Type: string)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          30. Patient.meta.extension:process-client-id
                                                                                          Slice Nameprocess-client-id
                                                                                          Definition

                                                                                          The HL7v2 Source Client Id for the message/event that was translated into FHIR Resource

                                                                                          ShortProcess Client ID
                                                                                          Control0..1
                                                                                          TypeExtension(Process Client ID) (Extension Type: string)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          32. Patient.meta.extension:l4h-template-version
                                                                                          Slice Namel4h-template-version
                                                                                          Definition

                                                                                          The version number of the l4h templates used to translate the hl7v2 message into FHIR Resource

                                                                                          ShortL4H Template Version
                                                                                          Control0..1
                                                                                          TypeExtension(L4H Template Version) (Extension Type: string)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          34. Patient.meta.versionId
                                                                                          Definition

                                                                                          The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                                                                                          ShortVersion specific identifier
                                                                                          Comments

                                                                                          The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                                                                                          Control0..1
                                                                                          Typeid
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          36. Patient.meta.lastUpdated
                                                                                          Definition

                                                                                          When the resource last changed - e.g. when the version changed.

                                                                                          ShortWhen the resource version last changed
                                                                                          Comments

                                                                                          This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                                                                                          Control0..1
                                                                                          Typeinstant
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          38. Patient.meta.source
                                                                                          Definition

                                                                                          A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                                                                                          ShortIdentifies where the resource comes from
                                                                                          Comments

                                                                                          In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                                                                                          This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                                                                                          Control0..1
                                                                                          Typeuri
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          40. Patient.meta.profile
                                                                                          Definition

                                                                                          A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                                                                                          ShortProfiles this resource claims to conform to
                                                                                          Comments

                                                                                          It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                                                                                          Control0..*
                                                                                          Typecanonical(StructureDefinition)
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          42. Patient.meta.security
                                                                                          Definition

                                                                                          Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                                                                                          ShortSecurity Labels applied to this resource
                                                                                          Comments

                                                                                          The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                                                          Control0..*
                                                                                          BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                                                                                          (extensible to http://hl7.org/fhir/ValueSet/security-labels)

                                                                                          Security Labels from the Healthcare Privacy and Security Classification System.

                                                                                          TypeCoding
                                                                                          Is Modifierfalse
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          44. Patient.meta.tag
                                                                                          Definition

                                                                                          Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                                                                                          ShortTags applied to this resource
                                                                                          Comments

                                                                                          The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                                                          Control0..*
                                                                                          BindingFor example codes, see CommonTags
                                                                                          (example to http://hl7.org/fhir/ValueSet/common-tags)

                                                                                          Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                                                                                          TypeCoding
                                                                                          Is Modifierfalse
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          46. Patient.implicitRules
                                                                                          Definition

                                                                                          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                                                                          ShortA set of rules under which this content was created
                                                                                          Comments

                                                                                          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                                                                          Control0..0
                                                                                          Typeuri
                                                                                          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          48. Patient.language
                                                                                          Definition

                                                                                          The base language in which the resource is written.

                                                                                          ShortLanguage of the resource content
                                                                                          Comments

                                                                                          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                                                                                          Control0..0
                                                                                          BindingThe codes SHOULD be taken from CommonLanguages
                                                                                          (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                                                          A human language.

                                                                                          Additional BindingsPurpose
                                                                                          AllLanguagesMax Binding
                                                                                          Typecode
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          50. Patient.text
                                                                                          Definition

                                                                                          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                                                                          ShortText summary of the resource, for human interpretation
                                                                                          Comments

                                                                                          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                                                                          Control0..1
                                                                                          TypeNarrative
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Alternate Namesnarrative, html, xhtml, display
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          52. Patient.contained
                                                                                          Definition

                                                                                          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                                                                          ShortContained, inline Resources
                                                                                          Comments

                                                                                          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                                                                          Control0..0
                                                                                          TypeResource
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Alternate Namesinline resources, anonymous resources, contained resources
                                                                                          54. Patient.extension
                                                                                          Definition

                                                                                          An Extension

                                                                                          ShortExtension
                                                                                          Control0..*
                                                                                          TypeExtension
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ url
                                                                                          • 56. Patient.extension:ethnicity
                                                                                            Slice Nameethnicity
                                                                                            Definition

                                                                                            The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

                                                                                            The Stats New Zealand standard can be found here.

                                                                                            ShortNZ Ethnicity
                                                                                            Control0..*
                                                                                            This element is affected by the following invariants: ele-1
                                                                                            TypeExtension(NZ Ethnicity) (Extension Type: CodeableConcept)
                                                                                            Is Modifierfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            58. Patient.extension:ethnicity.id
                                                                                            Definition

                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            60. Patient.extension:ethnicity.extension
                                                                                            Definition

                                                                                            An Extension

                                                                                            ShortExtension
                                                                                            Control0..0
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 62. Patient.extension:ethnicity.url
                                                                                              Definition

                                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                                              Shortidentifies the meaning of the extension
                                                                                              Comments

                                                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                              Control1..1
                                                                                              Typeuri
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
                                                                                              64. Patient.extension:ethnicity.value[x]
                                                                                              Definition

                                                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                              ShortValue of extension
                                                                                              Control1..1
                                                                                              TypeCodeableConcept
                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              SlicingThis element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                              • type @ $this
                                                                                              • 66. Patient.extension:ethnicity.value[x]:valueCodeableConcept
                                                                                                Slice NamevalueCodeableConcept
                                                                                                Definition

                                                                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                ShortValue of extension
                                                                                                Control1..1
                                                                                                BindingThe codes SHOULD be taken from Ethnicity of a person
                                                                                                (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code)
                                                                                                TypeCodeableConcept
                                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                Is Modifierfalse
                                                                                                Summaryfalse
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                68. Patient.extension:ethnicity.value[x]:valueCodeableConcept.id
                                                                                                Definition

                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                ShortUnique id for inter-element referencing
                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                70. Patient.extension:ethnicity.value[x]:valueCodeableConcept.extension
                                                                                                Definition

                                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                ShortAdditional content defined by implementations
                                                                                                Comments

                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                Control0..*
                                                                                                TypeExtension
                                                                                                Is Modifierfalse
                                                                                                Summaryfalse
                                                                                                Alternate Namesextensions, user content
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                SlicingThis element introduces a set of slices on Patient.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                • value @ url
                                                                                                • 72. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding
                                                                                                  Definition

                                                                                                  A reference to a code defined by a terminology system.

                                                                                                  ShortCode defined by a terminology system
                                                                                                  Comments

                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                  Control0..*
                                                                                                  TypeCoding
                                                                                                  Is Modifierfalse
                                                                                                  Summarytrue
                                                                                                  Requirements

                                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  74. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.id
                                                                                                  Definition

                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                  ShortUnique id for inter-element referencing
                                                                                                  Control0..1
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                  Summaryfalse
                                                                                                  76. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.extension
                                                                                                  Definition

                                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                  ShortAdditional content defined by implementations
                                                                                                  Comments

                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                  Control0..*
                                                                                                  TypeExtension
                                                                                                  Is Modifierfalse
                                                                                                  Summaryfalse
                                                                                                  Alternate Namesextensions, user content
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                  SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                  • value @ url
                                                                                                  • 78. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.system
                                                                                                    Definition

                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                    ShortIdentity of the terminology system
                                                                                                    Comments

                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                    Control0..1
                                                                                                    Typeuri
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    80. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.version
                                                                                                    Definition

                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                    ShortVersion of the system - if relevant
                                                                                                    Comments

                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    82. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.code
                                                                                                    Definition

                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                    Control0..1
                                                                                                    Typecode
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Need to refer to a particular code in the system.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    84. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.display
                                                                                                    Definition

                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                    ShortRepresentation defined by the system
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    86. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding.userSelected
                                                                                                    Definition

                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                    Comments

                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                    Control0..1
                                                                                                    Typeboolean
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    88. Patient.extension:ethnicity.value[x]:valueCodeableConcept.text
                                                                                                    Definition

                                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                    ShortPlain text representation of the concept
                                                                                                    Comments

                                                                                                    Very often the text is the same as a displayName of one of the codings.

                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    90. Patient.extension:nzCitizen
                                                                                                    Slice NamenzCitizen
                                                                                                    Definition

                                                                                                    New Zealand citizenship

                                                                                                    ShortNZ Citizenship
                                                                                                    Control0..1
                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                    TypeExtension(NZ Citizenship) (Complex Extension)
                                                                                                    Is Modifierfalse
                                                                                                    Must Supporttrue
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                    92. Patient.extension:nzCitizen.id
                                                                                                    Definition

                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                    ShortUnique id for inter-element referencing
                                                                                                    Control0..0
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                    Summaryfalse
                                                                                                    94. Patient.extension:nzCitizen.extension
                                                                                                    Definition

                                                                                                    An Extension

                                                                                                    ShortExtension
                                                                                                    Control1..*
                                                                                                    TypeExtension
                                                                                                    Is Modifierfalse
                                                                                                    Summaryfalse
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                    SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                    • value @ url
                                                                                                    • 96. Patient.extension:nzCitizen.extension:status
                                                                                                      Slice Namestatus
                                                                                                      Definition

                                                                                                      An Extension

                                                                                                      ShortExtension
                                                                                                      Control1..1
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Must Supporttrue
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      98. Patient.extension:nzCitizen.extension:status.id
                                                                                                      Definition

                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..0
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      100. Patient.extension:nzCitizen.extension:status.extension
                                                                                                      Definition

                                                                                                      An Extension

                                                                                                      ShortExtension
                                                                                                      Control0..0
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                      • value @ url
                                                                                                      • 102. Patient.extension:nzCitizen.extension:status.url
                                                                                                        Definition

                                                                                                        Source of the definition for the extension code - a logical name or a URL.

                                                                                                        Shortidentifies the meaning of the extension
                                                                                                        Comments

                                                                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                        Control1..1
                                                                                                        Typeuri
                                                                                                        Is Modifierfalse
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        Fixed Valuestatus
                                                                                                        104. Patient.extension:nzCitizen.extension:status.value[x]
                                                                                                        Definition

                                                                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                        ShortValue of extension
                                                                                                        Control0..1
                                                                                                        TypeCodeableConcept
                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                        Is Modifierfalse
                                                                                                        Summaryfalse
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                                        • type @ $this
                                                                                                        • 106. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept
                                                                                                          Slice NamevalueCodeableConcept
                                                                                                          Definition

                                                                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                          ShortValue of extension
                                                                                                          Control0..1
                                                                                                          BindingThe codes SHOULD be taken from NZ Citizenship status
                                                                                                          (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code)
                                                                                                          TypeCodeableConcept
                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          108. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.id
                                                                                                          Definition

                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                          ShortIs this person a New Zealand citizen? CodeableConcept: yes / no / unknown
                                                                                                          Control0..0
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          110. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.extension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                          • value @ url
                                                                                                          • 112. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding
                                                                                                            Definition

                                                                                                            A reference to a code defined by a terminology system.

                                                                                                            ShortCode defined by a terminology system
                                                                                                            Comments

                                                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                            Control1..1
                                                                                                            TypeCoding
                                                                                                            Is Modifierfalse
                                                                                                            Must Supporttrue
                                                                                                            Summarytrue
                                                                                                            Requirements

                                                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            114. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.id
                                                                                                            Definition

                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                            ShortUnique id for inter-element referencing
                                                                                                            Control0..1
                                                                                                            Typestring
                                                                                                            Is Modifierfalse
                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                            Summaryfalse
                                                                                                            116. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.extension
                                                                                                            Definition

                                                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                            ShortAdditional content defined by implementations
                                                                                                            Comments

                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                            Control0..*
                                                                                                            TypeExtension
                                                                                                            Is Modifierfalse
                                                                                                            Summaryfalse
                                                                                                            Alternate Namesextensions, user content
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                            SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                            • value @ url
                                                                                                            • 118. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.system
                                                                                                              Definition

                                                                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                              ShortIdentity of the terminology system
                                                                                                              Comments

                                                                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                              Control1..1
                                                                                                              Typeuri
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Requirements

                                                                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              120. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.version
                                                                                                              Definition

                                                                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                              ShortVersion of the system - if relevant
                                                                                                              Comments

                                                                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              122. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.code
                                                                                                              Definition

                                                                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                              ShortSymbol in syntax defined by the system
                                                                                                              Control1..1
                                                                                                              Typecode
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Requirements

                                                                                                              Need to refer to a particular code in the system.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              124. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.display
                                                                                                              Definition

                                                                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                              ShortRepresentation defined by the system
                                                                                                              Control1..1
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Requirements

                                                                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              126. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.userSelected
                                                                                                              Definition

                                                                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                              ShortIf this coding was chosen directly by the user
                                                                                                              Comments

                                                                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                              Control0..0
                                                                                                              Typeboolean
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summarytrue
                                                                                                              Requirements

                                                                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              128. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.text
                                                                                                              Definition

                                                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                              ShortPlain text representation of the concept
                                                                                                              Comments

                                                                                                              Very often the text is the same as a displayName of one of the codings.

                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summarytrue
                                                                                                              Requirements

                                                                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              130. Patient.extension:nzCitizen.extension:source
                                                                                                              Slice Namesource
                                                                                                              Definition

                                                                                                              An Extension

                                                                                                              ShortExtension
                                                                                                              Control0..0
                                                                                                              TypeExtension
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              137. Patient.extension:nzCitizen.url
                                                                                                              Definition

                                                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                                                              Shortidentifies the meaning of the extension
                                                                                                              Comments

                                                                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                              Control1..1
                                                                                                              Typeuri
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
                                                                                                              139. Patient.extension:nzCitizen.value[x]
                                                                                                              Definition

                                                                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                              ShortValue of extension
                                                                                                              Control0..0
                                                                                                              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              141. Patient.extension:dhb
                                                                                                              Slice Namedhb
                                                                                                              Definition

                                                                                                              District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

                                                                                                              ShortDistrict Health Board linked to a NZ Healthcare Service, Location or Patient
                                                                                                              Control0..1
                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                              TypeExtension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)
                                                                                                              Is Modifierfalse
                                                                                                              Must Supporttrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              143. Patient.extension:dhb.id
                                                                                                              Definition

                                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                              ShortUnique id for inter-element referencing
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              145. Patient.extension:dhb.extension
                                                                                                              Definition

                                                                                                              An Extension

                                                                                                              ShortExtension
                                                                                                              Control0..0
                                                                                                              TypeExtension
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                              • value @ url
                                                                                                              • 147. Patient.extension:dhb.url
                                                                                                                Definition

                                                                                                                Source of the definition for the extension code - a logical name or a URL.

                                                                                                                Shortidentifies the meaning of the extension
                                                                                                                Comments

                                                                                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                Control1..1
                                                                                                                Typeuri
                                                                                                                Is Modifierfalse
                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                Summaryfalse
                                                                                                                Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/dhb
                                                                                                                149. Patient.extension:dhb.value[x]
                                                                                                                Definition

                                                                                                                NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month.

                                                                                                                ShortNZ District Health Boards
                                                                                                                Control0..1
                                                                                                                BindingUnless not suitable, these codes SHALL be taken from District Health Board Identifer
                                                                                                                (extensible to https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code)

                                                                                                                NZ HPI-ORG Values for DHBs

                                                                                                                TypeCodeableConcept
                                                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                Is Modifierfalse
                                                                                                                Summaryfalse
                                                                                                                Requirements

                                                                                                                The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type.

                                                                                                                LabelDHB Code
                                                                                                                Example<br/><b>Waikato DHB</b>:{ "coding" : [{ "system" : "https://standards.digital.health.nz/ns/dhb-code", "version" : "1.0", "code" : "G00027-C", "display" : "Waikato" }] }
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                151. Patient.extension:dhb.value[x].id
                                                                                                                Definition

                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                Control0..1
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                Summaryfalse
                                                                                                                153. Patient.extension:dhb.value[x].extension
                                                                                                                Definition

                                                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                ShortAdditional content defined by implementations
                                                                                                                Comments

                                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                Control0..*
                                                                                                                TypeExtension
                                                                                                                Is Modifierfalse
                                                                                                                Summaryfalse
                                                                                                                Alternate Namesextensions, user content
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                SlicingThis element introduces a set of slices on Patient.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                • value @ url
                                                                                                                • 155. Patient.extension:dhb.value[x].coding
                                                                                                                  Definition

                                                                                                                  A reference to a code defined by a terminology system.

                                                                                                                  ShortCode defined by a terminology system
                                                                                                                  Comments

                                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                  Control1..1
                                                                                                                  TypeCoding
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  Summarytrue
                                                                                                                  Requirements

                                                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  157. Patient.extension:dhb.value[x].coding.id
                                                                                                                  Definition

                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                  Control0..1
                                                                                                                  Typestring
                                                                                                                  Is Modifierfalse
                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                  Summaryfalse
                                                                                                                  159. Patient.extension:dhb.value[x].coding.extension
                                                                                                                  Definition

                                                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                  ShortAdditional content defined by implementations
                                                                                                                  Comments

                                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                  Control0..*
                                                                                                                  TypeExtension
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Alternate Namesextensions, user content
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                  SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                  • value @ url
                                                                                                                  • 161. Patient.extension:dhb.value[x].coding.system
                                                                                                                    Definition

                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                    ShortIdentity of the terminology system
                                                                                                                    Comments

                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                    Control1..1
                                                                                                                    Typeuri
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    163. Patient.extension:dhb.value[x].coding.version
                                                                                                                    Definition

                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                    Comments

                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                    Control0..0
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Summarytrue
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    165. Patient.extension:dhb.value[x].coding.code
                                                                                                                    Definition

                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                    Control1..1
                                                                                                                    Typecode
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    167. Patient.extension:dhb.value[x].coding.display
                                                                                                                    Definition

                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                    ShortRepresentation defined by the system
                                                                                                                    Control1..1
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    169. Patient.extension:dhb.value[x].coding.userSelected
                                                                                                                    Definition

                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                    Comments

                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                    Control0..0
                                                                                                                    Typeboolean
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    171. Patient.extension:dhb.value[x].text
                                                                                                                    Definition

                                                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                    ShortPlain text representation of the concept
                                                                                                                    Comments

                                                                                                                    Very often the text is the same as a displayName of one of the codings.

                                                                                                                    Control0..0
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    173. Patient.extension:domicile-code
                                                                                                                    Slice Namedomicile-code
                                                                                                                    Definition

                                                                                                                    NZ Domicile Code. Derived from a patient's primary physical, home address.

                                                                                                                    ShortNZ Domicile Code
                                                                                                                    Control0..1
                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                    TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                                                                                                                    Is Modifierfalse
                                                                                                                    Must Supporttrue
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                    175. Patient.extension:domicile-code.id
                                                                                                                    Definition

                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                    Control0..0
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                    Summaryfalse
                                                                                                                    177. Patient.extension:domicile-code.extension
                                                                                                                    Definition

                                                                                                                    An Extension

                                                                                                                    ShortExtension
                                                                                                                    Control0..0
                                                                                                                    TypeExtension
                                                                                                                    Is Modifierfalse
                                                                                                                    Summaryfalse
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                    SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                    • value @ url
                                                                                                                    • 179. Patient.extension:domicile-code.url
                                                                                                                      Definition

                                                                                                                      Source of the definition for the extension code - a logical name or a URL.

                                                                                                                      Shortidentifies the meaning of the extension
                                                                                                                      Comments

                                                                                                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                      Control1..1
                                                                                                                      Typeuri
                                                                                                                      Is Modifierfalse
                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                      Summaryfalse
                                                                                                                      Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/domicile-code
                                                                                                                      181. Patient.extension:domicile-code.value[x]
                                                                                                                      Definition

                                                                                                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                      ShortValue of extension
                                                                                                                      Control0..1
                                                                                                                      TypeCodeableConcept
                                                                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                      Is Modifierfalse
                                                                                                                      Summaryfalse
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      SlicingThis element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                                                      • type @ $this
                                                                                                                      • 183. Patient.extension:domicile-code.value[x]:valueCodeableConcept
                                                                                                                        Slice NamevalueCodeableConcept
                                                                                                                        Definition

                                                                                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                        ShortValue of extension
                                                                                                                        Control0..1
                                                                                                                        BindingThe codes SHOULD be taken from Domicile Code
                                                                                                                        (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code)
                                                                                                                        TypeCodeableConcept
                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                        Is Modifierfalse
                                                                                                                        Summaryfalse
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                        185. Patient.extension:domicile-code.value[x]:valueCodeableConcept.id
                                                                                                                        Definition

                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                        Control0..1
                                                                                                                        Typestring
                                                                                                                        Is Modifierfalse
                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                        Summaryfalse
                                                                                                                        187. Patient.extension:domicile-code.value[x]:valueCodeableConcept.extension
                                                                                                                        Definition

                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                        ShortAdditional content defined by implementations
                                                                                                                        Comments

                                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                        Control0..*
                                                                                                                        TypeExtension
                                                                                                                        Is Modifierfalse
                                                                                                                        Summaryfalse
                                                                                                                        Alternate Namesextensions, user content
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                        SlicingThis element introduces a set of slices on Patient.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                        • value @ url
                                                                                                                        • 189. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding
                                                                                                                          Definition

                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                          ShortCode defined by a terminology system
                                                                                                                          Comments

                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                          Control1..1
                                                                                                                          TypeCoding
                                                                                                                          Is Modifierfalse
                                                                                                                          Must Supporttrue
                                                                                                                          Summarytrue
                                                                                                                          Requirements

                                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          191. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.id
                                                                                                                          Definition

                                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                          ShortUnique id for inter-element referencing
                                                                                                                          Control0..1
                                                                                                                          Typestring
                                                                                                                          Is Modifierfalse
                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                          Summaryfalse
                                                                                                                          193. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.extension
                                                                                                                          Definition

                                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                          ShortAdditional content defined by implementations
                                                                                                                          Comments

                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                          Control0..*
                                                                                                                          TypeExtension
                                                                                                                          Is Modifierfalse
                                                                                                                          Summaryfalse
                                                                                                                          Alternate Namesextensions, user content
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                          SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                          • value @ url
                                                                                                                          • 195. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.system
                                                                                                                            Definition

                                                                                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                            ShortIdentity of the terminology system
                                                                                                                            Comments

                                                                                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                            Control1..1
                                                                                                                            Typeuri
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            Summarytrue
                                                                                                                            Requirements

                                                                                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            197. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.version
                                                                                                                            Definition

                                                                                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                            ShortVersion of the system - if relevant
                                                                                                                            Comments

                                                                                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                            Control0..0
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Summarytrue
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            199. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.code
                                                                                                                            Definition

                                                                                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                            ShortSymbol in syntax defined by the system
                                                                                                                            Control1..1
                                                                                                                            Typecode
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            Summarytrue
                                                                                                                            Requirements

                                                                                                                            Need to refer to a particular code in the system.

                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            201. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.display
                                                                                                                            Definition

                                                                                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                            ShortRepresentation defined by the system
                                                                                                                            Control0..1
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            Summarytrue
                                                                                                                            Requirements

                                                                                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            203. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected
                                                                                                                            Definition

                                                                                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                            ShortIf this coding was chosen directly by the user
                                                                                                                            Comments

                                                                                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                            Control0..0
                                                                                                                            Typeboolean
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Summarytrue
                                                                                                                            Requirements

                                                                                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            205. Patient.extension:domicile-code.value[x]:valueCodeableConcept.text
                                                                                                                            Definition

                                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                            ShortPlain text representation of the concept
                                                                                                                            Comments

                                                                                                                            Very often the text is the same as a displayName of one of the codings.

                                                                                                                            Control0..0
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Summarytrue
                                                                                                                            Requirements

                                                                                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            207. Patient.extension:pho
                                                                                                                            Slice Namepho
                                                                                                                            Definition

                                                                                                                            Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

                                                                                                                            ShortPrimary Healthcare Organisation
                                                                                                                            Control0..0
                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                            TypeExtension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)
                                                                                                                            Is Modifierfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                            209. Patient.extension:sex-at-birth
                                                                                                                            Slice Namesex-at-birth
                                                                                                                            Definition

                                                                                                                            A person’s sex at the time of their birth (considered to be immutable).

                                                                                                                            ShortSex At Birth
                                                                                                                            Control0..0
                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                            TypeExtension(Sex At Birth) (Extension Type: CodeableConcept)
                                                                                                                            Is Modifierfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                            211. Patient.extension:iwi
                                                                                                                            Slice Nameiwi
                                                                                                                            Definition

                                                                                                                            Persons Iwi affiliation

                                                                                                                            ShortExtension
                                                                                                                            Control0..0
                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                            TypeExtension(Nz_iwi) (Extension Type: CodeableConcept)
                                                                                                                            Is Modifierfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                            213. Patient.extension:nzcrEthnicity
                                                                                                                            Slice NamenzcrEthnicity
                                                                                                                            Definition

                                                                                                                            The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

                                                                                                                            The Stats New Zealand standard can be found here.

                                                                                                                            ShortNZ Ethnicity (Central Region Edition)
                                                                                                                            Control0..3
                                                                                                                            TypeExtension(NZ Ethnicity (Central Region Edition)) (Extension Type: CodeableConcept)
                                                                                                                            Is Modifierfalse
                                                                                                                            Must Supporttrue
                                                                                                                            Summaryfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                            215. Patient.extension:nzcrEthnicity.id
                                                                                                                            Definition

                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                            Control0..0
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                            Summaryfalse
                                                                                                                            217. Patient.extension:nzcrEthnicity.extension
                                                                                                                            Definition

                                                                                                                            An Extension

                                                                                                                            ShortExtension
                                                                                                                            Control0..0
                                                                                                                            TypeExtension
                                                                                                                            Is Modifierfalse
                                                                                                                            Summaryfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                            SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                            • value @ url
                                                                                                                            • 219. Patient.extension:nzcrEthnicity.url
                                                                                                                              Definition

                                                                                                                              Source of the definition for the extension code - a logical name or a URL.

                                                                                                                              Shortidentifies the meaning of the extension
                                                                                                                              Comments

                                                                                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                              Control1..1
                                                                                                                              Typeuri
                                                                                                                              Is Modifierfalse
                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                              Summaryfalse
                                                                                                                              Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-ethnicity
                                                                                                                              221. Patient.extension:nzcrEthnicity.value[x]
                                                                                                                              Definition

                                                                                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                              ShortValue of extension
                                                                                                                              Control1..1
                                                                                                                              BindingThe codes SHALL be taken from NZ Central Region - Combined Ethnicity Value Set
                                                                                                                              (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity)
                                                                                                                              TypeCodeableConcept
                                                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                              Is Modifierfalse
                                                                                                                              Summaryfalse
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              223. Patient.extension:nzcrEthnicity.value[x].id
                                                                                                                              Definition

                                                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                              Control0..1
                                                                                                                              Typestring
                                                                                                                              Is Modifierfalse
                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                              Summaryfalse
                                                                                                                              225. Patient.extension:nzcrEthnicity.value[x].extension
                                                                                                                              Definition

                                                                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                              ShortAdditional content defined by implementations
                                                                                                                              Comments

                                                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                              Control0..*
                                                                                                                              TypeExtension
                                                                                                                              Is Modifierfalse
                                                                                                                              Summaryfalse
                                                                                                                              Alternate Namesextensions, user content
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                              SlicingThis element introduces a set of slices on Patient.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                              • value @ url
                                                                                                                              • 227. Patient.extension:nzcrEthnicity.value[x].coding
                                                                                                                                Definition

                                                                                                                                A reference to a code defined by a terminology system.

                                                                                                                                ShortCode defined by a terminology system
                                                                                                                                Comments

                                                                                                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                Control2..*
                                                                                                                                TypeCoding
                                                                                                                                Is Modifierfalse
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Requirements

                                                                                                                                Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                SlicingThis element introduces a set of slices on Patient.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                • pattern @ system
                                                                                                                                • 229. Patient.extension:nzcrEthnicity.value[x].coding.id
                                                                                                                                  Definition

                                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                  Control0..1
                                                                                                                                  Typestring
                                                                                                                                  Is Modifierfalse
                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                  Summaryfalse
                                                                                                                                  231. Patient.extension:nzcrEthnicity.value[x].coding.extension
                                                                                                                                  Definition

                                                                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                  ShortAdditional content defined by implementations
                                                                                                                                  Comments

                                                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                  Control0..*
                                                                                                                                  TypeExtension
                                                                                                                                  Is Modifierfalse
                                                                                                                                  Summaryfalse
                                                                                                                                  Alternate Namesextensions, user content
                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                  SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                  • value @ url
                                                                                                                                  • 233. Patient.extension:nzcrEthnicity.value[x].coding.system
                                                                                                                                    Definition

                                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                    ShortIdentity of the terminology system
                                                                                                                                    Comments

                                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                    Control1..1
                                                                                                                                    Typeuri
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    235. Patient.extension:nzcrEthnicity.value[x].coding.version
                                                                                                                                    Definition

                                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                                    Comments

                                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                    Control0..0
                                                                                                                                    Typestring
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                    Summarytrue
                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    237. Patient.extension:nzcrEthnicity.value[x].coding.code
                                                                                                                                    Definition

                                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                                    Control1..1
                                                                                                                                    Typecode
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    239. Patient.extension:nzcrEthnicity.value[x].coding.display
                                                                                                                                    Definition

                                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                    ShortRepresentation defined by the system
                                                                                                                                    Control1..1
                                                                                                                                    Typestring
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    241. Patient.extension:nzcrEthnicity.value[x].coding.userSelected
                                                                                                                                    Definition

                                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                                    Comments

                                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                    Control0..0
                                                                                                                                    Typeboolean
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    243. Patient.extension:nzcrEthnicity.value[x].coding:level2
                                                                                                                                    Slice Namelevel2
                                                                                                                                    Definition

                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                    Comments

                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                    Control1..1
                                                                                                                                    TypeCoding
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    245. Patient.extension:nzcrEthnicity.value[x].coding:level2.id
                                                                                                                                    Definition

                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                    Control0..1
                                                                                                                                    Typestring
                                                                                                                                    Is Modifierfalse
                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                    Summaryfalse
                                                                                                                                    247. Patient.extension:nzcrEthnicity.value[x].coding:level2.extension
                                                                                                                                    Definition

                                                                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                    ShortAdditional content defined by implementations
                                                                                                                                    Comments

                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                    Control0..*
                                                                                                                                    TypeExtension
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Summaryfalse
                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                    SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                    • value @ url
                                                                                                                                    • 249. Patient.extension:nzcrEthnicity.value[x].coding:level2.system
                                                                                                                                      Definition

                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                      Comments

                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                      Control1..1
                                                                                                                                      Typeuri
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                      Fixed Valuehttps://standards.digital.health.nz/ns/ethnic-group-level-2-code
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      251. Patient.extension:nzcrEthnicity.value[x].coding:level2.version
                                                                                                                                      Definition

                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                      Comments

                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                      Control0..0
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      253. Patient.extension:nzcrEthnicity.value[x].coding:level2.code
                                                                                                                                      Definition

                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                      Control1..1
                                                                                                                                      BindingThe codes SHALL be taken from NZ Central Region - Ethnicity Level 2 Value Set
                                                                                                                                      (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2)
                                                                                                                                      Typecode
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      255. Patient.extension:nzcrEthnicity.value[x].coding:level2.display
                                                                                                                                      Definition

                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                      Control1..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      257. Patient.extension:nzcrEthnicity.value[x].coding:level2.userSelected
                                                                                                                                      Definition

                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                      Comments

                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                      Control0..0
                                                                                                                                      Typeboolean
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      259. Patient.extension:nzcrEthnicity.value[x].coding:level4
                                                                                                                                      Slice Namelevel4
                                                                                                                                      Definition

                                                                                                                                      A reference to a code defined by a terminology system.

                                                                                                                                      ShortCode defined by a terminology system
                                                                                                                                      Comments

                                                                                                                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                      Control1..1
                                                                                                                                      TypeCoding
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      261. Patient.extension:nzcrEthnicity.value[x].coding:level4.id
                                                                                                                                      Definition

                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                      Summaryfalse
                                                                                                                                      263. Patient.extension:nzcrEthnicity.value[x].coding:level4.extension
                                                                                                                                      Definition

                                                                                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                                      Comments

                                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                      Control0..*
                                                                                                                                      TypeExtension
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Summaryfalse
                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                      SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                      • value @ url
                                                                                                                                      • 265. Patient.extension:nzcrEthnicity.value[x].coding:level4.system
                                                                                                                                        Definition

                                                                                                                                        The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                        ShortIdentity of the terminology system
                                                                                                                                        Comments

                                                                                                                                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                        Control1..1
                                                                                                                                        Typeuri
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summarytrue
                                                                                                                                        Requirements

                                                                                                                                        Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                        Fixed Valuehttps://standards.digital.health.nz/ns/ethnic-group-level-4-code
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        267. Patient.extension:nzcrEthnicity.value[x].coding:level4.version
                                                                                                                                        Definition

                                                                                                                                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                        ShortVersion of the system - if relevant
                                                                                                                                        Comments

                                                                                                                                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                        NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                        Control0..0
                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Summarytrue
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        269. Patient.extension:nzcrEthnicity.value[x].coding:level4.code
                                                                                                                                        Definition

                                                                                                                                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                        ShortSymbol in syntax defined by the system
                                                                                                                                        Control1..1
                                                                                                                                        BindingThe codes SHALL be taken from Ethnicity of a person
                                                                                                                                        (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code)
                                                                                                                                        Typecode
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summarytrue
                                                                                                                                        Requirements

                                                                                                                                        Need to refer to a particular code in the system.

                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        271. Patient.extension:nzcrEthnicity.value[x].coding:level4.display
                                                                                                                                        Definition

                                                                                                                                        A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                        ShortRepresentation defined by the system
                                                                                                                                        Control1..1
                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summarytrue
                                                                                                                                        Requirements

                                                                                                                                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        273. Patient.extension:nzcrEthnicity.value[x].coding:level4.userSelected
                                                                                                                                        Definition

                                                                                                                                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                        ShortIf this coding was chosen directly by the user
                                                                                                                                        Comments

                                                                                                                                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                        Control0..0
                                                                                                                                        Typeboolean
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Summarytrue
                                                                                                                                        Requirements

                                                                                                                                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        275. Patient.extension:nzcrEthnicity.value[x].text
                                                                                                                                        Definition

                                                                                                                                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                        ShortPlain text representation of the concept
                                                                                                                                        Comments

                                                                                                                                        Very often the text is the same as a displayName of one of the codings.

                                                                                                                                        Control0..0
                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Summarytrue
                                                                                                                                        Requirements

                                                                                                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        277. Patient.extension:nzcrResidency
                                                                                                                                        Slice NamenzcrResidency
                                                                                                                                        Definition

                                                                                                                                        NZ Residency status, permits multiple codings from different CodeSystems

                                                                                                                                        ShortNZ Residency (Central Region Edition)
                                                                                                                                        Control0..1
                                                                                                                                        TypeExtension(NZ Residency (Central Region Edition)) (Complex Extension)
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Must Supporttrue
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                        279. Patient.extension:nzcrResidency.id
                                                                                                                                        Definition

                                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                        Control0..0
                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                        Summaryfalse
                                                                                                                                        281. Patient.extension:nzcrResidency.extension
                                                                                                                                        Definition

                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                        ShortAdditional content defined by implementations
                                                                                                                                        Comments

                                                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                        Control0..*
                                                                                                                                        TypeExtension
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Summaryfalse
                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                        SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                        • value @ url
                                                                                                                                        • 283. Patient.extension:nzcrResidency.extension:status
                                                                                                                                          Slice Namestatus
                                                                                                                                          Definition

                                                                                                                                          An Extension

                                                                                                                                          ShortExtension
                                                                                                                                          Control0..1
                                                                                                                                          TypeExtension
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Summaryfalse
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                          285. Patient.extension:nzcrResidency.extension:status.id
                                                                                                                                          Definition

                                                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                          ShortUnique id for inter-element referencing
                                                                                                                                          Control0..0
                                                                                                                                          Typestring
                                                                                                                                          Is Modifierfalse
                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                          Summaryfalse
                                                                                                                                          287. Patient.extension:nzcrResidency.extension:status.extension
                                                                                                                                          Definition

                                                                                                                                          An Extension

                                                                                                                                          ShortExtension
                                                                                                                                          Control0..0
                                                                                                                                          TypeExtension
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Summaryfalse
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                          SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                          • value @ url
                                                                                                                                          • 289. Patient.extension:nzcrResidency.extension:status.url
                                                                                                                                            Definition

                                                                                                                                            Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                            Shortidentifies the meaning of the extension
                                                                                                                                            Comments

                                                                                                                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                            Control1..1
                                                                                                                                            Typeuri
                                                                                                                                            Is Modifierfalse
                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                            Summaryfalse
                                                                                                                                            Fixed Valuestatus
                                                                                                                                            291. Patient.extension:nzcrResidency.extension:status.value[x]
                                                                                                                                            Definition

                                                                                                                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                            ShortValue of extension
                                                                                                                                            Control0..1
                                                                                                                                            BindingThe codes SHALL be taken from NZ Central Region - Combined NZ Residency Value Set
                                                                                                                                            (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency)
                                                                                                                                            TypeCodeableConcept
                                                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                            Is Modifierfalse
                                                                                                                                            Summaryfalse
                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                            293. Patient.extension:nzcrResidency.extension:status.value[x].id
                                                                                                                                            Definition

                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                            Control0..1
                                                                                                                                            Typestring
                                                                                                                                            Is Modifierfalse
                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                            Summaryfalse
                                                                                                                                            295. Patient.extension:nzcrResidency.extension:status.value[x].extension
                                                                                                                                            Definition

                                                                                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                            ShortAdditional content defined by implementations
                                                                                                                                            Comments

                                                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                            Control0..*
                                                                                                                                            TypeExtension
                                                                                                                                            Is Modifierfalse
                                                                                                                                            Summaryfalse
                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                            SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                            • value @ url
                                                                                                                                            • 297. Patient.extension:nzcrResidency.extension:status.value[x].coding
                                                                                                                                              Definition

                                                                                                                                              A reference to a code defined by a terminology system.

                                                                                                                                              ShortCode defined by a terminology system
                                                                                                                                              Comments

                                                                                                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                              Control2..*
                                                                                                                                              TypeCoding
                                                                                                                                              Is Modifierfalse
                                                                                                                                              Must Supporttrue
                                                                                                                                              Summarytrue
                                                                                                                                              Requirements

                                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                              SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                              • pattern @ system
                                                                                                                                              • 299. Patient.extension:nzcrResidency.extension:status.value[x].coding.id
                                                                                                                                                Definition

                                                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                Control0..1
                                                                                                                                                Typestring
                                                                                                                                                Is Modifierfalse
                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                Summaryfalse
                                                                                                                                                301. Patient.extension:nzcrResidency.extension:status.value[x].coding.extension
                                                                                                                                                Definition

                                                                                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                ShortAdditional content defined by implementations
                                                                                                                                                Comments

                                                                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                Control0..*
                                                                                                                                                TypeExtension
                                                                                                                                                Is Modifierfalse
                                                                                                                                                Summaryfalse
                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                • value @ url
                                                                                                                                                • 303. Patient.extension:nzcrResidency.extension:status.value[x].coding.system
                                                                                                                                                  Definition

                                                                                                                                                  The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                  ShortIdentity of the terminology system
                                                                                                                                                  Comments

                                                                                                                                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                  Control1..1
                                                                                                                                                  Typeuri
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                  Must Supporttrue
                                                                                                                                                  Summarytrue
                                                                                                                                                  Requirements

                                                                                                                                                  Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  305. Patient.extension:nzcrResidency.extension:status.value[x].coding.version
                                                                                                                                                  Definition

                                                                                                                                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                  ShortVersion of the system - if relevant
                                                                                                                                                  Comments

                                                                                                                                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                  Control0..0
                                                                                                                                                  Typestring
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                  Summarytrue
                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  307. Patient.extension:nzcrResidency.extension:status.value[x].coding.code
                                                                                                                                                  Definition

                                                                                                                                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                  ShortSymbol in syntax defined by the system
                                                                                                                                                  Control1..1
                                                                                                                                                  Typecode
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                  Must Supporttrue
                                                                                                                                                  Summarytrue
                                                                                                                                                  Requirements

                                                                                                                                                  Need to refer to a particular code in the system.

                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  309. Patient.extension:nzcrResidency.extension:status.value[x].coding.display
                                                                                                                                                  Definition

                                                                                                                                                  A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                  ShortRepresentation defined by the system
                                                                                                                                                  Control1..1
                                                                                                                                                  Typestring
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                  Must Supporttrue
                                                                                                                                                  Summarytrue
                                                                                                                                                  Requirements

                                                                                                                                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  311. Patient.extension:nzcrResidency.extension:status.value[x].coding.userSelected
                                                                                                                                                  Definition

                                                                                                                                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                  ShortIf this coding was chosen directly by the user
                                                                                                                                                  Comments

                                                                                                                                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                  Control0..0
                                                                                                                                                  Typeboolean
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                  Summarytrue
                                                                                                                                                  Requirements

                                                                                                                                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  313. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase
                                                                                                                                                  Slice NamenzBase
                                                                                                                                                  Definition

                                                                                                                                                  A reference to a code defined by a terminology system.

                                                                                                                                                  ShortCode defined by a terminology system
                                                                                                                                                  Comments

                                                                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                  Control1..1
                                                                                                                                                  TypeCoding
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Summarytrue
                                                                                                                                                  Requirements

                                                                                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  315. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.id
                                                                                                                                                  Definition

                                                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                  Control0..1
                                                                                                                                                  Typestring
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                  Summaryfalse
                                                                                                                                                  317. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.extension
                                                                                                                                                  Definition

                                                                                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                  ShortAdditional content defined by implementations
                                                                                                                                                  Comments

                                                                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                  Control0..*
                                                                                                                                                  TypeExtension
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Summaryfalse
                                                                                                                                                  Alternate Namesextensions, user content
                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                  SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                  • value @ url
                                                                                                                                                  • 319. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.system
                                                                                                                                                    Definition

                                                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                    ShortIdentity of the terminology system
                                                                                                                                                    Comments

                                                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                    Control1..1
                                                                                                                                                    Typeuri
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                    Must Supporttrue
                                                                                                                                                    Summarytrue
                                                                                                                                                    Requirements

                                                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                    Pattern Valuehttps://standards.digital.health.nz/ns/nz-residency-code
                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    321. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.version
                                                                                                                                                    Definition

                                                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                                                    Comments

                                                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                    Control0..0
                                                                                                                                                    Typestring
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                    Summarytrue
                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    323. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code
                                                                                                                                                    Definition

                                                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                                                    Control1..1
                                                                                                                                                    BindingThe codes SHALL be taken from NZ Residency status
                                                                                                                                                    (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code)
                                                                                                                                                    Typecode
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                    Must Supporttrue
                                                                                                                                                    Summarytrue
                                                                                                                                                    Requirements

                                                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    325. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.display
                                                                                                                                                    Definition

                                                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                    ShortRepresentation defined by the system
                                                                                                                                                    Control1..1
                                                                                                                                                    Typestring
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                    Must Supporttrue
                                                                                                                                                    Summarytrue
                                                                                                                                                    Requirements

                                                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    327. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.userSelected
                                                                                                                                                    Definition

                                                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                                                    Comments

                                                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                    Control0..0
                                                                                                                                                    Typeboolean
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                    Summarytrue
                                                                                                                                                    Requirements

                                                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    329. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource
                                                                                                                                                    Slice NamerawSource
                                                                                                                                                    Definition

                                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                                    Comments

                                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                    Control1..1
                                                                                                                                                    TypeCoding
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Summarytrue
                                                                                                                                                    Requirements

                                                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    331. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.id
                                                                                                                                                    Definition

                                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                    Control0..1
                                                                                                                                                    Typestring
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                    Summaryfalse
                                                                                                                                                    333. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.extension
                                                                                                                                                    Definition

                                                                                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                    ShortAdditional content defined by implementations
                                                                                                                                                    Comments

                                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                    Control0..*
                                                                                                                                                    TypeExtension
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Summaryfalse
                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                    SlicingThis element introduces a set of slices on Patient.extension.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                    • value @ url
                                                                                                                                                    • 335. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.system
                                                                                                                                                      Definition

                                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                                      Comments

                                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                      Control1..1
                                                                                                                                                      Typeuri
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

                                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                      Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-residency-code
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      337. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.version
                                                                                                                                                      Definition

                                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                                      Comments

                                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                      Control0..0
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Summarytrue
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      339. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code
                                                                                                                                                      Definition

                                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                                      Control1..1
                                                                                                                                                      BindingThe codes SHALL be taken from NZ Central Region - NZ Residency Value Set
                                                                                                                                                      (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency)
                                                                                                                                                      Typecode
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

                                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      341. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.display
                                                                                                                                                      Definition

                                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                                      Control1..1
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

                                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      343. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.userSelected
                                                                                                                                                      Definition

                                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                                      Comments

                                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                      Control0..0
                                                                                                                                                      Typeboolean
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

                                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      345. Patient.extension:nzcrResidency.extension:status.value[x].text
                                                                                                                                                      Definition

                                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                                      Comments

                                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                      Control0..0
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

                                                                                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      347. Patient.extension:nzcrResidency.extension:source
                                                                                                                                                      Slice Namesource
                                                                                                                                                      Definition

                                                                                                                                                      An Extension

                                                                                                                                                      ShortExtension
                                                                                                                                                      Control0..0
                                                                                                                                                      TypeExtension
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                      353. Patient.extension:nzcrResidency.url
                                                                                                                                                      Definition

                                                                                                                                                      Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                                      Shortidentifies the meaning of the extension
                                                                                                                                                      Comments

                                                                                                                                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                                      Control1..1
                                                                                                                                                      Typeuri
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Fixed Valuehttps://standards.digital.health.nz/ns/central-region/nz-residency
                                                                                                                                                      355. Patient.extension:nzcrResidency.value[x]
                                                                                                                                                      Definition

                                                                                                                                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                                      ShortValue of extension
                                                                                                                                                      Control0..0
                                                                                                                                                      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      357. Patient.extension:nzcrReligion
                                                                                                                                                      Slice NamenzcrReligion
                                                                                                                                                      Definition

                                                                                                                                                      Patient religious affiliation extension, permits multiple codings from different CodeSystems

                                                                                                                                                      ShortReligious Affiliation (Central Region Edition)
                                                                                                                                                      Control0..1
                                                                                                                                                      TypeExtension(Religious Affiliation (Central Region Edition)) (Extension Type: CodeableConcept)
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                      359. Patient.extension:nzcrReligion.id
                                                                                                                                                      Definition

                                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                      Control0..1
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                      Summaryfalse
                                                                                                                                                      361. Patient.extension:nzcrReligion.extension
                                                                                                                                                      Definition

                                                                                                                                                      An Extension

                                                                                                                                                      ShortExtension
                                                                                                                                                      Control0..0
                                                                                                                                                      TypeExtension
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                      SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                      • value @ url
                                                                                                                                                      • 363. Patient.extension:nzcrReligion.url
                                                                                                                                                        Definition

                                                                                                                                                        Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                                        Shortidentifies the meaning of the extension
                                                                                                                                                        Comments

                                                                                                                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                                        Control1..1
                                                                                                                                                        Typeuri
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                        Summaryfalse
                                                                                                                                                        Fixed Valuehttps://standards.digital.health.nz/ns/central-region/religion
                                                                                                                                                        365. Patient.extension:nzcrReligion.value[x]
                                                                                                                                                        Definition

                                                                                                                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                                        ShortValue of extension
                                                                                                                                                        Control1..1
                                                                                                                                                        BindingThe codes SHALL be taken from NZ Central Region - Combined Religion Value Set
                                                                                                                                                        (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion)
                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        Summaryfalse
                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                        367. Patient.extension:nzcrReligion.value[x].id
                                                                                                                                                        Definition

                                                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                        Control0..0
                                                                                                                                                        Typestring
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                        Summaryfalse
                                                                                                                                                        369. Patient.extension:nzcrReligion.value[x].extension
                                                                                                                                                        Definition

                                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                        ShortAdditional content defined by implementations
                                                                                                                                                        Comments

                                                                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                        Control0..*
                                                                                                                                                        TypeExtension
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        Summaryfalse
                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                        SlicingThis element introduces a set of slices on Patient.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                        • value @ url
                                                                                                                                                        • 371. Patient.extension:nzcrReligion.value[x].coding
                                                                                                                                                          Definition

                                                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                                                          ShortCode defined by a terminology system
                                                                                                                                                          Comments

                                                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                          Control1..*
                                                                                                                                                          TypeCoding
                                                                                                                                                          Is Modifierfalse
                                                                                                                                                          Must Supporttrue
                                                                                                                                                          Summarytrue
                                                                                                                                                          Requirements

                                                                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          SlicingThis element introduces a set of slices on Patient.extension.value[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                          • pattern @ system
                                                                                                                                                          • 373. Patient.extension:nzcrReligion.value[x].coding.id
                                                                                                                                                            Definition

                                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                            Control0..1
                                                                                                                                                            Typestring
                                                                                                                                                            Is Modifierfalse
                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                            Summaryfalse
                                                                                                                                                            375. Patient.extension:nzcrReligion.value[x].coding.extension
                                                                                                                                                            Definition

                                                                                                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                            ShortAdditional content defined by implementations
                                                                                                                                                            Comments

                                                                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                            Control0..*
                                                                                                                                                            TypeExtension
                                                                                                                                                            Is Modifierfalse
                                                                                                                                                            Summaryfalse
                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                            SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                            • value @ url
                                                                                                                                                            • 377. Patient.extension:nzcrReligion.value[x].coding.system
                                                                                                                                                              Definition

                                                                                                                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                              ShortIdentity of the terminology system
                                                                                                                                                              Comments

                                                                                                                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                              Control1..1
                                                                                                                                                              Typeuri
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              379. Patient.extension:nzcrReligion.value[x].coding.version
                                                                                                                                                              Definition

                                                                                                                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                              ShortVersion of the system - if relevant
                                                                                                                                                              Comments

                                                                                                                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                              Control0..0
                                                                                                                                                              Typestring
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Summarytrue
                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              381. Patient.extension:nzcrReligion.value[x].coding.code
                                                                                                                                                              Definition

                                                                                                                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                              ShortSymbol in syntax defined by the system
                                                                                                                                                              Control1..1
                                                                                                                                                              Typecode
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Need to refer to a particular code in the system.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              383. Patient.extension:nzcrReligion.value[x].coding.display
                                                                                                                                                              Definition

                                                                                                                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                              ShortRepresentation defined by the system
                                                                                                                                                              Control1..1
                                                                                                                                                              Typestring
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              385. Patient.extension:nzcrReligion.value[x].coding.userSelected
                                                                                                                                                              Definition

                                                                                                                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                              ShortIf this coding was chosen directly by the user
                                                                                                                                                              Comments

                                                                                                                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                              Control0..0
                                                                                                                                                              Typeboolean
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              387. Patient.extension:nzcrReligion.value[x].coding:origFhir
                                                                                                                                                              Slice NameorigFhir
                                                                                                                                                              Definition

                                                                                                                                                              A reference to a code defined by a terminology system.

                                                                                                                                                              ShortCode defined by a terminology system
                                                                                                                                                              Comments

                                                                                                                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                              Control0..1
                                                                                                                                                              TypeCoding
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              389. Patient.extension:nzcrReligion.value[x].coding:origFhir.id
                                                                                                                                                              Definition

                                                                                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                              Control0..1
                                                                                                                                                              Typestring
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                              Summaryfalse
                                                                                                                                                              391. Patient.extension:nzcrReligion.value[x].coding:origFhir.extension
                                                                                                                                                              Definition

                                                                                                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                              ShortAdditional content defined by implementations
                                                                                                                                                              Comments

                                                                                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                              Control0..*
                                                                                                                                                              TypeExtension
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Summaryfalse
                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                              SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                              • value @ url
                                                                                                                                                              • 393. Patient.extension:nzcrReligion.value[x].coding:origFhir.system
                                                                                                                                                                Definition

                                                                                                                                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                ShortIdentity of the terminology system
                                                                                                                                                                Comments

                                                                                                                                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                Control1..1
                                                                                                                                                                Typeuri
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                Must Supporttrue
                                                                                                                                                                Summarytrue
                                                                                                                                                                Requirements

                                                                                                                                                                Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                395. Patient.extension:nzcrReligion.value[x].coding:origFhir.version
                                                                                                                                                                Definition

                                                                                                                                                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                ShortVersion of the system - if relevant
                                                                                                                                                                Comments

                                                                                                                                                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                Control0..0
                                                                                                                                                                Typestring
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                Summarytrue
                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                397. Patient.extension:nzcrReligion.value[x].coding:origFhir.code
                                                                                                                                                                Definition

                                                                                                                                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                ShortSymbol in syntax defined by the system
                                                                                                                                                                Control1..1
                                                                                                                                                                BindingThe codes SHALL be taken from ReligiousAffiliation
                                                                                                                                                                (required to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation)
                                                                                                                                                                Typecode
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                Must Supporttrue
                                                                                                                                                                Summarytrue
                                                                                                                                                                Requirements

                                                                                                                                                                Need to refer to a particular code in the system.

                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                399. Patient.extension:nzcrReligion.value[x].coding:origFhir.display
                                                                                                                                                                Definition

                                                                                                                                                                A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                ShortRepresentation defined by the system
                                                                                                                                                                Control1..1
                                                                                                                                                                Typestring
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                Must Supporttrue
                                                                                                                                                                Summarytrue
                                                                                                                                                                Requirements

                                                                                                                                                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                401. Patient.extension:nzcrReligion.value[x].coding:origFhir.userSelected
                                                                                                                                                                Definition

                                                                                                                                                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                ShortIf this coding was chosen directly by the user
                                                                                                                                                                Comments

                                                                                                                                                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                Control0..0
                                                                                                                                                                Typeboolean
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                Summarytrue
                                                                                                                                                                Requirements

                                                                                                                                                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                403. Patient.extension:nzcrReligion.value[x].coding:rawSource
                                                                                                                                                                Slice NamerawSource
                                                                                                                                                                Definition

                                                                                                                                                                A reference to a code defined by a terminology system.

                                                                                                                                                                ShortCode defined by a terminology system
                                                                                                                                                                Comments

                                                                                                                                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                Control1..1
                                                                                                                                                                TypeCoding
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Summarytrue
                                                                                                                                                                Requirements

                                                                                                                                                                Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                405. Patient.extension:nzcrReligion.value[x].coding:rawSource.id
                                                                                                                                                                Definition

                                                                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                Control0..1
                                                                                                                                                                Typestring
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                Summaryfalse
                                                                                                                                                                407. Patient.extension:nzcrReligion.value[x].coding:rawSource.extension
                                                                                                                                                                Definition

                                                                                                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                ShortAdditional content defined by implementations
                                                                                                                                                                Comments

                                                                                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                Control0..*
                                                                                                                                                                TypeExtension
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Summaryfalse
                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                SlicingThis element introduces a set of slices on Patient.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                • value @ url
                                                                                                                                                                • 409. Patient.extension:nzcrReligion.value[x].coding:rawSource.system
                                                                                                                                                                  Definition

                                                                                                                                                                  The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                  ShortIdentity of the terminology system
                                                                                                                                                                  Comments

                                                                                                                                                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                  Control1..1
                                                                                                                                                                  Typeuri
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Requirements

                                                                                                                                                                  Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                  Fixed Valuehttps://standards.digital.health.nz/ns/central-region/patient-religion
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  411. Patient.extension:nzcrReligion.value[x].coding:rawSource.version
                                                                                                                                                                  Definition

                                                                                                                                                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                  ShortVersion of the system - if relevant
                                                                                                                                                                  Comments

                                                                                                                                                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                  Control0..0
                                                                                                                                                                  Typestring
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  413. Patient.extension:nzcrReligion.value[x].coding:rawSource.code
                                                                                                                                                                  Definition

                                                                                                                                                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                  ShortSymbol in syntax defined by the system
                                                                                                                                                                  Control1..1
                                                                                                                                                                  BindingThe codes SHALL be taken from NZ Central Region - Combined Religion Value Set
                                                                                                                                                                  (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion)
                                                                                                                                                                  Typecode
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Requirements

                                                                                                                                                                  Need to refer to a particular code in the system.

                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  415. Patient.extension:nzcrReligion.value[x].coding:rawSource.display
                                                                                                                                                                  Definition

                                                                                                                                                                  A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                  ShortRepresentation defined by the system
                                                                                                                                                                  Control1..1
                                                                                                                                                                  Typestring
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Requirements

                                                                                                                                                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  417. Patient.extension:nzcrReligion.value[x].coding:rawSource.userSelected
                                                                                                                                                                  Definition

                                                                                                                                                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                  ShortIf this coding was chosen directly by the user
                                                                                                                                                                  Comments

                                                                                                                                                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                  Control0..0
                                                                                                                                                                  Typeboolean
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Requirements

                                                                                                                                                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  419. Patient.extension:nzcrReligion.value[x].text
                                                                                                                                                                  Definition

                                                                                                                                                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                  ShortPlain text representation of the concept
                                                                                                                                                                  Comments

                                                                                                                                                                  Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                  Control0..0
                                                                                                                                                                  Typestring
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Requirements

                                                                                                                                                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  421. Patient.extension:interpreterRequired
                                                                                                                                                                  Slice NameinterpreterRequired
                                                                                                                                                                  Definition

                                                                                                                                                                  This Patient requires an interpreter to communicate healthcare information to the practitioner.

                                                                                                                                                                  ShortWhether the patient needs an interpreter
                                                                                                                                                                  Comments

                                                                                                                                                                  The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.

                                                                                                                                                                  Control0..1
                                                                                                                                                                  TypeExtension(Patient Interpreter Required) (Extension Type: boolean)
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                  Summaryfalse
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                  423. Patient.extension:interpreterRequired.id
                                                                                                                                                                  Definition

                                                                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                                  Control0..1
                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                  Typeid
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                  Summaryfalse
                                                                                                                                                                  425. Patient.extension:interpreterRequired.extension
                                                                                                                                                                  Definition

                                                                                                                                                                  An Extension

                                                                                                                                                                  ShortExtension
                                                                                                                                                                  Control0..0
                                                                                                                                                                  TypeExtension
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  Summaryfalse
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                  SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                  • value @ url
                                                                                                                                                                  • 427. Patient.extension:interpreterRequired.url
                                                                                                                                                                    Definition

                                                                                                                                                                    Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                                                    Shortidentifies the meaning of the extension
                                                                                                                                                                    Comments

                                                                                                                                                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                                                    Control1..1
                                                                                                                                                                    Typeuri
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                    Summaryfalse
                                                                                                                                                                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
                                                                                                                                                                    429. Patient.extension:interpreterRequired.value[x]
                                                                                                                                                                    Definition

                                                                                                                                                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                                                    ShortValue of extension
                                                                                                                                                                    Control1..1
                                                                                                                                                                    This element is affected by the following invariants: ext-1
                                                                                                                                                                    Typeboolean
                                                                                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                    Summaryfalse
                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                    431. Patient.modifierExtension
                                                                                                                                                                    Definition

                                                                                                                                                                    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                                                                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                                                                                    ShortExtensions that cannot be ignored
                                                                                                                                                                    Comments

                                                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                    Control0..*
                                                                                                                                                                    TypeExtension
                                                                                                                                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                                                                                                                                                    Summaryfalse
                                                                                                                                                                    Requirements

                                                                                                                                                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                    433. Patient.identifier
                                                                                                                                                                    Definition

                                                                                                                                                                    An identifier for this patient.

                                                                                                                                                                    ShortAn identifier for this patient
                                                                                                                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                    Control1..*
                                                                                                                                                                    TypeIdentifier
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                    Summarytrue
                                                                                                                                                                    Requirements

                                                                                                                                                                    Patients are almost always assigned specific numerical identifiers.

                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                    SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                    • value @ system
                                                                                                                                                                    • 435. Patient.identifier.id
                                                                                                                                                                      Definition

                                                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                      Control0..0
                                                                                                                                                                      Typestring
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                      Summaryfalse
                                                                                                                                                                      437. Patient.identifier.extension
                                                                                                                                                                      Definition

                                                                                                                                                                      An Extension

                                                                                                                                                                      ShortExtension
                                                                                                                                                                      Control0..0
                                                                                                                                                                      TypeExtension
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      Summaryfalse
                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                      SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                      • value @ url
                                                                                                                                                                      • 439. Patient.identifier.use
                                                                                                                                                                        Definition

                                                                                                                                                                        The purpose of this identifier.

                                                                                                                                                                        Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                                        Comments

                                                                                                                                                                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                                        Control1..1
                                                                                                                                                                        BindingThe codes SHALL be taken from IdentifierUse
                                                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                                                                                                        Identifies the purpose for this identifier, if known .

                                                                                                                                                                        Typecode
                                                                                                                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                        Summarytrue
                                                                                                                                                                        Requirements

                                                                                                                                                                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        441. Patient.identifier.type
                                                                                                                                                                        Definition

                                                                                                                                                                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                        ShortDescription of identifier
                                                                                                                                                                        Comments

                                                                                                                                                                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                                        Control1..1
                                                                                                                                                                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                                                                                                        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                                                                                                                                        A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                        Summarytrue
                                                                                                                                                                        Requirements

                                                                                                                                                                        Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        443. Patient.identifier.type.id
                                                                                                                                                                        Definition

                                                                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                        Control0..1
                                                                                                                                                                        Typestring
                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                        Summaryfalse
                                                                                                                                                                        445. Patient.identifier.type.extension
                                                                                                                                                                        Definition

                                                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                        ShortAdditional content defined by implementations
                                                                                                                                                                        Comments

                                                                                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                        Control0..*
                                                                                                                                                                        TypeExtension
                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                        Summaryfalse
                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                        SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                        • value @ url
                                                                                                                                                                        • 447. Patient.identifier.type.coding
                                                                                                                                                                          Definition

                                                                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                                                                          ShortCode defined by a terminology system
                                                                                                                                                                          Comments

                                                                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                          Control0..*
                                                                                                                                                                          TypeCoding
                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                          Summarytrue
                                                                                                                                                                          Requirements

                                                                                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                          449. Patient.identifier.type.coding.id
                                                                                                                                                                          Definition

                                                                                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                          ShortUnique id for inter-element referencing
                                                                                                                                                                          Control0..1
                                                                                                                                                                          Typestring
                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                          Summaryfalse
                                                                                                                                                                          451. Patient.identifier.type.coding.extension
                                                                                                                                                                          Definition

                                                                                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                          ShortAdditional content defined by implementations
                                                                                                                                                                          Comments

                                                                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                          Control0..*
                                                                                                                                                                          TypeExtension
                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                          Summaryfalse
                                                                                                                                                                          Alternate Namesextensions, user content
                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                          SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                          • value @ url
                                                                                                                                                                          • 453. Patient.identifier.type.coding.system
                                                                                                                                                                            Definition

                                                                                                                                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                            ShortIdentity of the terminology system
                                                                                                                                                                            Comments

                                                                                                                                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                            Control1..1
                                                                                                                                                                            Typeuri
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            455. Patient.identifier.type.coding.version
                                                                                                                                                                            Definition

                                                                                                                                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                            ShortVersion of the system - if relevant
                                                                                                                                                                            Comments

                                                                                                                                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                            Control0..1
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            457. Patient.identifier.type.coding.code
                                                                                                                                                                            Definition

                                                                                                                                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                            ShortSymbol in syntax defined by the system
                                                                                                                                                                            Control1..1
                                                                                                                                                                            Typecode
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Need to refer to a particular code in the system.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            459. Patient.identifier.type.coding.display
                                                                                                                                                                            Definition

                                                                                                                                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                            ShortRepresentation defined by the system
                                                                                                                                                                            Control1..1
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            461. Patient.identifier.type.coding.userSelected
                                                                                                                                                                            Definition

                                                                                                                                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                            ShortIf this coding was chosen directly by the user
                                                                                                                                                                            Comments

                                                                                                                                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                            Control0..1
                                                                                                                                                                            Typeboolean
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            463. Patient.identifier.type.text
                                                                                                                                                                            Definition

                                                                                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                            ShortPlain text representation of the concept
                                                                                                                                                                            Comments

                                                                                                                                                                            Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                            Control0..1
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            465. Patient.identifier.system
                                                                                                                                                                            Definition

                                                                                                                                                                            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                                            ShortThe namespace for the identifier value
                                                                                                                                                                            Comments

                                                                                                                                                                            Identifier.system is always case sensitive.

                                                                                                                                                                            Control1..1
                                                                                                                                                                            Typeuri
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                                            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            467. Patient.identifier.value
                                                                                                                                                                            Definition

                                                                                                                                                                            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                                            ShortThe value that is unique
                                                                                                                                                                            Comments

                                                                                                                                                                            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                                            Control1..1
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Example<br/><b>General</b>:123456
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            469. Patient.identifier.period
                                                                                                                                                                            Definition

                                                                                                                                                                            Time period during which identifier is/was valid for use.

                                                                                                                                                                            ShortTime period when id is/was valid for use
                                                                                                                                                                            Control0..0
                                                                                                                                                                            TypePeriod
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            471. Patient.identifier.assigner
                                                                                                                                                                            Definition

                                                                                                                                                                            Organization that issued/manages the identifier.

                                                                                                                                                                            ShortOrganization that issued id (may be just text)
                                                                                                                                                                            Comments

                                                                                                                                                                            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                                            Control0..0
                                                                                                                                                                            TypeReference(Organization)
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            473. Patient.identifier:NHI
                                                                                                                                                                            Slice NameNHI
                                                                                                                                                                            Definition

                                                                                                                                                                            An identifier for this patient.

                                                                                                                                                                            ShortAn identifier for this patient
                                                                                                                                                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                            Control0..*
                                                                                                                                                                            TypeIdentifier
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Patients are almost always assigned specific numerical identifiers.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            475. Patient.identifier:NHI.id
                                                                                                                                                                            Definition

                                                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                            Control0..0
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                            Summaryfalse
                                                                                                                                                                            477. Patient.identifier:NHI.extension
                                                                                                                                                                            Definition

                                                                                                                                                                            An Extension

                                                                                                                                                                            ShortExtension
                                                                                                                                                                            Control0..0
                                                                                                                                                                            TypeExtension
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Summaryfalse
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                            SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                            • value @ url
                                                                                                                                                                            • 479. Patient.identifier:NHI.use
                                                                                                                                                                              Definition

                                                                                                                                                                              The purpose of this identifier.

                                                                                                                                                                              Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                                              Comments

                                                                                                                                                                              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                                              Control1..1
                                                                                                                                                                              BindingThe codes SHALL be taken from Valid use values for NHI
                                                                                                                                                                              (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code)
                                                                                                                                                                              Typecode
                                                                                                                                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Requirements

                                                                                                                                                                              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              481. Patient.identifier:NHI.type
                                                                                                                                                                              Definition

                                                                                                                                                                              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                              ShortDescription of identifier
                                                                                                                                                                              Comments

                                                                                                                                                                              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                                              Control1..1
                                                                                                                                                                              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                                                                                                              (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                                                                                                                                              A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                              TypeCodeableConcept
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Requirements

                                                                                                                                                                              Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              483. Patient.identifier:NHI.system
                                                                                                                                                                              Definition

                                                                                                                                                                              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                                              ShortThe namespace for the identifier value
                                                                                                                                                                              Comments

                                                                                                                                                                              Identifier.system is always case sensitive.

                                                                                                                                                                              Control1..1
                                                                                                                                                                              Typeuri
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Requirements

                                                                                                                                                                              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                                              Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
                                                                                                                                                                              Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              485. Patient.identifier:NHI.value
                                                                                                                                                                              Definition

                                                                                                                                                                              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                                              ShortThe value that is unique
                                                                                                                                                                              Comments

                                                                                                                                                                              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                                              Control1..1
                                                                                                                                                                              Typestring
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Example<br/><b>General</b>:123456
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              487. Patient.identifier:NHI.period
                                                                                                                                                                              Definition

                                                                                                                                                                              Time period during which identifier is/was valid for use.

                                                                                                                                                                              ShortTime period when id is/was valid for use
                                                                                                                                                                              Control0..0
                                                                                                                                                                              TypePeriod
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              489. Patient.identifier:NHI.assigner
                                                                                                                                                                              Definition

                                                                                                                                                                              Organization that issued/manages the identifier.

                                                                                                                                                                              ShortOrganization that issued id (may be just text)
                                                                                                                                                                              Comments

                                                                                                                                                                              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                                              Control0..0
                                                                                                                                                                              TypeReference(Organization)
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              491. Patient.active
                                                                                                                                                                              Definition

                                                                                                                                                                              Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                                                                                                                                                              It is often used to filter patient lists to exclude inactive patients

                                                                                                                                                                              Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                                                                                                                                                              ShortWhether this patient's record is in active use
                                                                                                                                                                              Comments

                                                                                                                                                                              If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                                                                                                                                                              Control0..1
                                                                                                                                                                              Typeboolean
                                                                                                                                                                              Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Requirements

                                                                                                                                                                              Need to be able to mark a patient record as not to be used because it was created in error.

                                                                                                                                                                              Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              493. Patient.name
                                                                                                                                                                              Definition

                                                                                                                                                                              A name associated with the individual.

                                                                                                                                                                              ShortA name associated with the patient
                                                                                                                                                                              Comments

                                                                                                                                                                              A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                                                                                                                              Control1..*
                                                                                                                                                                              TypeHumanName
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Requirements

                                                                                                                                                                              Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              495. Patient.name.id
                                                                                                                                                                              Definition

                                                                                                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                              Control0..0
                                                                                                                                                                              Typestring
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                              Summaryfalse
                                                                                                                                                                              497. Patient.name.extension
                                                                                                                                                                              Definition

                                                                                                                                                                              An Extension

                                                                                                                                                                              ShortExtension
                                                                                                                                                                              Control0..0
                                                                                                                                                                              TypeExtension
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Summaryfalse
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                              SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                              • value @ url
                                                                                                                                                                              • 499. Patient.name.use
                                                                                                                                                                                Definition

                                                                                                                                                                                Identifies the purpose for this name.

                                                                                                                                                                                Shortone of: usual / old
                                                                                                                                                                                Comments

                                                                                                                                                                                Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                                                                                                                                Control1..1
                                                                                                                                                                                BindingThe codes SHALL be taken from NameUse
                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                                                                                                                                                The use of a human name.

                                                                                                                                                                                Typecode
                                                                                                                                                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Requirements

                                                                                                                                                                                Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                501. Patient.name.text
                                                                                                                                                                                Definition

                                                                                                                                                                                Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                                                                                                                                ShortText representation of the full name
                                                                                                                                                                                Comments

                                                                                                                                                                                Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                                                                                                                                Control1..1
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Requirements

                                                                                                                                                                                A renderable, unencoded form.

                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                503. Patient.name.family
                                                                                                                                                                                Definition

                                                                                                                                                                                The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                                                                                                                ShortFamily name (often called 'Surname')
                                                                                                                                                                                Comments

                                                                                                                                                                                Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                                                                                                                                Control1..1
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Alternate Namessurname
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                505. Patient.name.given
                                                                                                                                                                                Definition

                                                                                                                                                                                Given name.

                                                                                                                                                                                ShortGiven names (not always 'first'). Includes middle names
                                                                                                                                                                                Comments

                                                                                                                                                                                If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                                                                                                                                Control0..*
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Alternate Namesfirst name, middle name
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                507. Patient.name.prefix
                                                                                                                                                                                Definition

                                                                                                                                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                                                                                                                ShortParts that come before the name
                                                                                                                                                                                Control0..*
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                509. Patient.name.suffix
                                                                                                                                                                                Definition

                                                                                                                                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                                                                                                                                ShortParts that come after the name
                                                                                                                                                                                Control0..0
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                511. Patient.name.period
                                                                                                                                                                                Definition

                                                                                                                                                                                Indicates the period of time when this name was valid for the named person.

                                                                                                                                                                                ShortTime period when name was/is in use
                                                                                                                                                                                Control0..1
                                                                                                                                                                                TypePeriod
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Requirements

                                                                                                                                                                                Allows names to be placed in historical context.

                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                513. Patient.telecom
                                                                                                                                                                                Definition

                                                                                                                                                                                Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                                                                                                                                                ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)
                                                                                                                                                                                Comments

                                                                                                                                                                                A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                                                                                                Control0..*
                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                TypeContactPoint(Common NZ ContactPoint datatype)
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Requirements

                                                                                                                                                                                People have (primary) ways to contact them in some way such as phone, email.

                                                                                                                                                                                Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                                                                                                                                                                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                515. Patient.telecom.id
                                                                                                                                                                                Definition

                                                                                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                Control0..0
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                517. Patient.telecom.extension
                                                                                                                                                                                Definition

                                                                                                                                                                                An Extension

                                                                                                                                                                                ShortExtension
                                                                                                                                                                                Control0..0
                                                                                                                                                                                TypeExtension
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                • value @ url
                                                                                                                                                                                • 519. Patient.telecom.extension:cp-purpose
                                                                                                                                                                                  Slice Namecp-purpose
                                                                                                                                                                                  Definition

                                                                                                                                                                                  A specific purpose for which this ContactPoint dataType would be used. An example would be to indicate that this ContactPoint is used for video conferencing.

                                                                                                                                                                                  ShortA specific purpose for which this ContactPoint dataType would be used
                                                                                                                                                                                  Control0..0
                                                                                                                                                                                  TypeExtension(A specific purpose for which this ContactPoint dataType would be used) (Extension Type: CodeableConcept)
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                  521. Patient.telecom.system
                                                                                                                                                                                  Definition

                                                                                                                                                                                  Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                                                                                                                                  Shortphone | fax | email | pager | url | sms | other
                                                                                                                                                                                  Control1..1
                                                                                                                                                                                  This element is affected by the following invariants: cpt-2
                                                                                                                                                                                  BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                                                                                                  (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                                                                                                  Telecommunications form for contact point.

                                                                                                                                                                                  Typecode
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  523. Patient.telecom.value
                                                                                                                                                                                  Definition

                                                                                                                                                                                  The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                                                                                                                                  ShortThe actual contact point details
                                                                                                                                                                                  Comments

                                                                                                                                                                                  Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                                                                                                                                                  Control1..1
                                                                                                                                                                                  Typestring
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Requirements

                                                                                                                                                                                  Need to support legacy numbers that are not in a tightly controlled format.

                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  525. Patient.telecom.use
                                                                                                                                                                                  Definition

                                                                                                                                                                                  Identifies the purpose for the contact point.

                                                                                                                                                                                  Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                                                                                                                                  Comments

                                                                                                                                                                                  Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                                                                                                                                  Control1..1
                                                                                                                                                                                  BindingThe codes SHALL be taken from ContactPointUse
                                                                                                                                                                                  (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                                                                                                                                                  Use of contact point.

                                                                                                                                                                                  Typecode
                                                                                                                                                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Requirements

                                                                                                                                                                                  Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  527. Patient.telecom.rank
                                                                                                                                                                                  Definition

                                                                                                                                                                                  Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                                                                                                  ShortSpecify preferred order of use (1 = highest)
                                                                                                                                                                                  Comments

                                                                                                                                                                                  Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                                                                                                                                  Control0..0
                                                                                                                                                                                  TypepositiveInt
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  529. Patient.telecom.period
                                                                                                                                                                                  Definition

                                                                                                                                                                                  Time period when the contact point was/is in use.

                                                                                                                                                                                  ShortTime period when the contact point was/is in use
                                                                                                                                                                                  Control0..0
                                                                                                                                                                                  TypePeriod
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  531. Patient.gender
                                                                                                                                                                                  Definition

                                                                                                                                                                                  Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                                                                                                                                                                                  Shortmale | female | other | unknown
                                                                                                                                                                                  Comments

                                                                                                                                                                                  The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                                                                                                                                                  Control1..1
                                                                                                                                                                                  BindingThe codes SHALL be taken from AdministrativeGender
                                                                                                                                                                                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                                                                                                                                  The gender of a person used for administrative purposes.

                                                                                                                                                                                  Typecode
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Requirements

                                                                                                                                                                                  Needed for identification of the individual, in combination with (at least) name and birth date.

                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  533. Patient.birthDate
                                                                                                                                                                                  Definition

                                                                                                                                                                                  The date of birth for the individual.

                                                                                                                                                                                  ShortThe date of birth for the individual
                                                                                                                                                                                  Comments

                                                                                                                                                                                  At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                                                                                                                                                                                  Control1..1
                                                                                                                                                                                  Typedate
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Requirements

                                                                                                                                                                                  Age of the individual drives many clinical processes.

                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  LOINC Code21112-8
                                                                                                                                                                                  535. Patient.deceased[x]
                                                                                                                                                                                  Definition

                                                                                                                                                                                  Indicates if the individual is deceased or not.

                                                                                                                                                                                  ShortdeceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known
                                                                                                                                                                                  Comments

                                                                                                                                                                                  If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                                                                                                                                  Control1..1
                                                                                                                                                                                  TypeChoice of: boolean, dateTime
                                                                                                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                  Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Requirements

                                                                                                                                                                                  The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                                                                                                                  • type @ $this
                                                                                                                                                                                  • 537. Patient.deceased[x]:deceasedDateTime
                                                                                                                                                                                    Slice NamedeceasedDateTime
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Indicates if the individual is deceased or not.

                                                                                                                                                                                    ShortIndicates if the individual is deceased or not
                                                                                                                                                                                    Comments

                                                                                                                                                                                    If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    TypedateTime
                                                                                                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                    Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Requirements

                                                                                                                                                                                    The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    539. Patient.deceased[x]:deceasedBoolean
                                                                                                                                                                                    Slice NamedeceasedBoolean
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Indicates if the individual is deceased or not.

                                                                                                                                                                                    ShortIndicates if the individual is deceased or not
                                                                                                                                                                                    Comments

                                                                                                                                                                                    If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    Typeboolean
                                                                                                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                    Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Requirements

                                                                                                                                                                                    The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    541. Patient.address
                                                                                                                                                                                    Definition

                                                                                                                                                                                    An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                                                                                                                                                                                    ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                                                                                                                                                                                    Comments

                                                                                                                                                                                    Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                                                                                                                                    Control0..*
                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                    TypeAddress(Common NZ Address datatype)
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                    Requirements

                                                                                                                                                                                    May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    543. Patient.address.id
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                    Control0..0
                                                                                                                                                                                    Typestring
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                    545. Patient.address.extension
                                                                                                                                                                                    Definition

                                                                                                                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                                    ShortAdditional content defined by implementations
                                                                                                                                                                                    Comments

                                                                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                    Control0..*
                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                    SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                    • value @ url
                                                                                                                                                                                    • 547. Patient.address.extension:nz-geocode
                                                                                                                                                                                      Slice Namenz-geocode
                                                                                                                                                                                      Definition

                                                                                                                                                                                      New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

                                                                                                                                                                                      ShortNZ Geocode
                                                                                                                                                                                      Control0..0
                                                                                                                                                                                      TypeExtension(NZ Geocode) (Complex Extension)
                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                      549. Patient.address.extension:suburb
                                                                                                                                                                                      Slice Namesuburb
                                                                                                                                                                                      Definition

                                                                                                                                                                                      Suburb element of a NZ Address.

                                                                                                                                                                                      ShortNZ Suburb
                                                                                                                                                                                      Control0..1
                                                                                                                                                                                      TypeExtension(NZ Suburb) (Extension Type: string)
                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                      551. Patient.address.extension:suburb.id
                                                                                                                                                                                      Definition

                                                                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                      Control0..1
                                                                                                                                                                                      Typestring
                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                      553. Patient.address.extension:suburb.extension
                                                                                                                                                                                      Definition

                                                                                                                                                                                      An Extension

                                                                                                                                                                                      ShortExtension
                                                                                                                                                                                      Control0..0
                                                                                                                                                                                      TypeExtension
                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                      SlicingThis element introduces a set of slices on Patient.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                      • value @ url
                                                                                                                                                                                      • 555. Patient.address.extension:suburb.url
                                                                                                                                                                                        Definition

                                                                                                                                                                                        Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                                                                        Shortidentifies the meaning of the extension
                                                                                                                                                                                        Comments

                                                                                                                                                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                                                                        Control1..1
                                                                                                                                                                                        Typeuri
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/suburb
                                                                                                                                                                                        557. Patient.address.extension:suburb.value[x]
                                                                                                                                                                                        Definition

                                                                                                                                                                                        NZ Suburbs

                                                                                                                                                                                        ShortNZSuburb
                                                                                                                                                                                        Comments

                                                                                                                                                                                        NZ Suburbs are defined in the NZ Electronic Street Address Mapping (eSAM) standard.

                                                                                                                                                                                        Control0..1
                                                                                                                                                                                        Typestring
                                                                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        LabelNZ Suburb
                                                                                                                                                                                        Example<br/><b>Rototuna</b>:Rototuna
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        559. Patient.address.extension:building-name
                                                                                                                                                                                        Slice Namebuilding-name
                                                                                                                                                                                        Definition

                                                                                                                                                                                        The name of a building cited in an address.

                                                                                                                                                                                        ShortBuilding Name
                                                                                                                                                                                        Control0..0
                                                                                                                                                                                        TypeExtension(Building Name) (Extension Type: string)
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                        561. Patient.address.extension:domicile-code
                                                                                                                                                                                        Slice Namedomicile-code
                                                                                                                                                                                        Definition

                                                                                                                                                                                        NZ Domicile Code. Derived from a patient's primary physical, home address.

                                                                                                                                                                                        ShortNZ Domicile Code
                                                                                                                                                                                        Control0..1
                                                                                                                                                                                        TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                        563. Patient.address.extension:domicile-code.id
                                                                                                                                                                                        Definition

                                                                                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                        Control0..0
                                                                                                                                                                                        Typestring
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        565. Patient.address.extension:domicile-code.extension
                                                                                                                                                                                        Definition

                                                                                                                                                                                        An Extension

                                                                                                                                                                                        ShortExtension
                                                                                                                                                                                        Control0..0
                                                                                                                                                                                        TypeExtension
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                        SlicingThis element introduces a set of slices on Patient.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                        • value @ url
                                                                                                                                                                                        • 567. Patient.address.extension:domicile-code.url
                                                                                                                                                                                          Definition

                                                                                                                                                                                          Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                                                                          Shortidentifies the meaning of the extension
                                                                                                                                                                                          Comments

                                                                                                                                                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                                                                          Control1..1
                                                                                                                                                                                          Typeuri
                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                          Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/domicile-code
                                                                                                                                                                                          569. Patient.address.extension:domicile-code.value[x]
                                                                                                                                                                                          Definition

                                                                                                                                                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                                                                          ShortValue of extension
                                                                                                                                                                                          Control0..1
                                                                                                                                                                                          TypeCodeableConcept
                                                                                                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                          SlicingThis element introduces a set of slices on Patient.address.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                                                                                                                          • type @ $this
                                                                                                                                                                                          • 571. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept
                                                                                                                                                                                            Slice NamevalueCodeableConcept
                                                                                                                                                                                            Definition

                                                                                                                                                                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                                                                            ShortValue of extension
                                                                                                                                                                                            Control0..1
                                                                                                                                                                                            BindingThe codes SHOULD be taken from Domicile Code
                                                                                                                                                                                            (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code)
                                                                                                                                                                                            TypeCodeableConcept
                                                                                                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                            573. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.id
                                                                                                                                                                                            Definition

                                                                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                            Control0..1
                                                                                                                                                                                            Typestring
                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                            575. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.extension
                                                                                                                                                                                            Definition

                                                                                                                                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                                            ShortAdditional content defined by implementations
                                                                                                                                                                                            Comments

                                                                                                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                            Control0..*
                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                            SlicingThis element introduces a set of slices on Patient.address.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                            • value @ url
                                                                                                                                                                                            • 577. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding
                                                                                                                                                                                              Definition

                                                                                                                                                                                              A reference to a code defined by a terminology system.

                                                                                                                                                                                              ShortCode defined by a terminology system
                                                                                                                                                                                              Comments

                                                                                                                                                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                              Control1..1
                                                                                                                                                                                              TypeCoding
                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                              Requirements

                                                                                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                              579. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.id
                                                                                                                                                                                              Definition

                                                                                                                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                              Control0..1
                                                                                                                                                                                              Typestring
                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                              581. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.extension
                                                                                                                                                                                              Definition

                                                                                                                                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                                              ShortAdditional content defined by implementations
                                                                                                                                                                                              Comments

                                                                                                                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                              Control0..*
                                                                                                                                                                                              TypeExtension
                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                              SlicingThis element introduces a set of slices on Patient.address.extension.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                              • value @ url
                                                                                                                                                                                              • 583. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.system
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                ShortIdentity of the terminology system
                                                                                                                                                                                                Comments

                                                                                                                                                                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                Typeuri
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                585. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.version
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                ShortVersion of the system - if relevant
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                587. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.code
                                                                                                                                                                                                Definition

                                                                                                                                                                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                ShortSymbol in syntax defined by the system
                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                Typecode
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                Need to refer to a particular code in the system.

                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                589. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.display
                                                                                                                                                                                                Definition

                                                                                                                                                                                                A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                ShortRepresentation defined by the system
                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                591. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                Typeboolean
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                593. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.text
                                                                                                                                                                                                Definition

                                                                                                                                                                                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                                ShortPlain text representation of the concept
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                595. Patient.address.use
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The purpose of this address.

                                                                                                                                                                                                Shorthome | work | temp | old | billing - purpose of this address
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                BindingThe codes SHALL be taken from AddressUse
                                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                                                                                                                                                                The use of an address.

                                                                                                                                                                                                Typecode
                                                                                                                                                                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                Allows an appropriate address to be chosen from a list of many.

                                                                                                                                                                                                Example<br/><b>General</b>:home
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                597. Patient.address.type
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                                                                                                                                                                ShortPHYSICAL | POSTAL
                                                                                                                                                                                                Comments

                                                                                                                                                                                                The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                BindingThe codes SHALL be taken from AddressType
                                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                                                                                                                                                                The type of an address (physical / postal).

                                                                                                                                                                                                Typecode
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Example<br/><b>General</b>:both
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                599. Patient.address.text
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                                                                                                                                                                ShortText representation of the address
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                A renderable, unencoded form.

                                                                                                                                                                                                Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                601. Patient.address.line
                                                                                                                                                                                                Definition

                                                                                                                                                                                                This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                                                                                                                                                                                ShortStreet name, number, direction & P.O. Box etc.
                                                                                                                                                                                                Control0..2
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Example<br/><b>General</b>:137 Nowhere Street
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                603. Patient.address.city
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The name of the city, town, suburb, village or other community or delivery center.

                                                                                                                                                                                                ShortName of city, town etc.
                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Alternate NamesMunicpality
                                                                                                                                                                                                Example<br/><b>General</b>:Erewhon
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                605. Patient.address.district
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The name of the administrative area (county).

                                                                                                                                                                                                ShortDistrict name (aka county)
                                                                                                                                                                                                Comments

                                                                                                                                                                                                District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Alternate NamesCounty
                                                                                                                                                                                                Example<br/><b>General</b>:Madison
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                607. Patient.address.state
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                                                                                                                                                                ShortSub-unit of country (abbreviations ok)
                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Alternate NamesProvince, Territory
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                609. Patient.address.postalCode
                                                                                                                                                                                                Definition

                                                                                                                                                                                                A postal code designating a region defined by the postal service.

                                                                                                                                                                                                ShortPostal code for area
                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Alternate NamesZip
                                                                                                                                                                                                Example<br/><b>General</b>:9132
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                611. Patient.address.country
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Country - a nation as commonly understood or generally accepted.

                                                                                                                                                                                                ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                                                                                                                                                                Comments

                                                                                                                                                                                                ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                613. Patient.address.period
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Time period when address was/is in use.

                                                                                                                                                                                                ShortTime period when address was/is in use
                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                TypePeriod
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                Allows addresses to be placed in historical context.

                                                                                                                                                                                                Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                615. Patient.maritalStatus
                                                                                                                                                                                                Definition

                                                                                                                                                                                                This field contains a patient's most recent marital (civil) status.

                                                                                                                                                                                                ShortMarital (civil) status of a patient
                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                BindingThe codes SHALL be taken from NZ Central Region - Marital Status Value Set
                                                                                                                                                                                                (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status)
                                                                                                                                                                                                TypeCodeableConcept
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                Requirements

                                                                                                                                                                                                Most, if not all systems capture it.

                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                617. Patient.maritalStatus.id
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                619. Patient.maritalStatus.extension
                                                                                                                                                                                                Definition

                                                                                                                                                                                                An Extension

                                                                                                                                                                                                ShortExtension
                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                TypeExtension
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                SlicingThis element introduces a set of slices on Patient.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                • value @ url
                                                                                                                                                                                                • 621. Patient.maritalStatus.coding
                                                                                                                                                                                                  Definition

                                                                                                                                                                                                  A reference to a code defined by a terminology system.

                                                                                                                                                                                                  ShortCode defined by a terminology system
                                                                                                                                                                                                  Comments

                                                                                                                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                                  Control1..*
                                                                                                                                                                                                  TypeCoding
                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                  Requirements

                                                                                                                                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                  623. Patient.maritalStatus.coding.id
                                                                                                                                                                                                  Definition

                                                                                                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                                                                  Control0..0
                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                  625. Patient.maritalStatus.coding.extension
                                                                                                                                                                                                  Definition

                                                                                                                                                                                                  An Extension

                                                                                                                                                                                                  ShortExtension
                                                                                                                                                                                                  Control0..0
                                                                                                                                                                                                  TypeExtension
                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                  SlicingThis element introduces a set of slices on Patient.maritalStatus.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                  • value @ url
                                                                                                                                                                                                  • 627. Patient.maritalStatus.coding.system
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                    ShortIdentity of the terminology system
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    629. Patient.maritalStatus.coding.version
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    631. Patient.maritalStatus.coding.code
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                    Typecode
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    633. Patient.maritalStatus.coding.display
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                    ShortRepresentation defined by the system
                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    635. Patient.maritalStatus.coding.userSelected
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    Typeboolean
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    637. Patient.maritalStatus.text
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                                    ShortPlain text representation of the concept
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    639. Patient.multipleBirth[x]
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                                                                                                                                    ShortWhether patient is part of a multiple birth
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    TypeChoice of: boolean, integer
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    641. Patient.photo
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    Image of the patient.

                                                                                                                                                                                                    ShortImage of the patient
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    Guidelines:

                                                                                                                                                                                                    • Use id photos, not clinical photos.
                                                                                                                                                                                                    • Limit dimensions to thumbnail.
                                                                                                                                                                                                    • Keep byte count low to ease resource updates.
                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    TypeAttachment
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    643. Patient.contact
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                                                                                                                                    ShortA contact party (e.g. guardian, partner, friend) for the patient
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                                                                                                                                    Control0..*
                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Need to track people you can contact about the patient.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                                                                                                                                    645. Patient.contact.id
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    647. Patient.contact.extension
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    An Extension

                                                                                                                                                                                                    ShortExtension
                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                    649. Patient.contact.modifierExtension
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                                                                                                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                                    Control0..*
                                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                    651. Patient.contact.relationship
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    The nature of the relationship between the patient and the contact person.

                                                                                                                                                                                                    ShortThe kind of relationship
                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                    BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                                                                                                                                    (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                                                                                                                                    The nature of the relationship between a patient and a contact person for that patient.

                                                                                                                                                                                                    TypeCodeableConcept
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                    Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    653. Patient.contact.relationship.id
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    655. Patient.contact.relationship.extension
                                                                                                                                                                                                    Definition

                                                                                                                                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                                                    ShortAdditional content defined by implementations
                                                                                                                                                                                                    Comments

                                                                                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                                    Control0..*
                                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                    SlicingThis element introduces a set of slices on Patient.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                    • 657. Patient.contact.relationship.extension:contact-relationship
                                                                                                                                                                                                      Slice Namecontact-relationship
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      Coding extension recording the original contact relationship value from NK1-HL7 v2 message that was used to create / update the FHIR resource

                                                                                                                                                                                                      ShortContact Relationship
                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      TypeExtension(Contact Relationship) (Extension Type: Coding)
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                      659. Patient.contact.relationship.extension:contact-relationship.id
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                      661. Patient.contact.relationship.extension:contact-relationship.extension
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      An Extension

                                                                                                                                                                                                      ShortExtension
                                                                                                                                                                                                      Control0..0
                                                                                                                                                                                                      TypeExtension
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                      SlicingThis element introduces a set of slices on Patient.contact.relationship.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                      • value @ url
                                                                                                                                                                                                      • 663. Patient.contact.relationship.extension:contact-relationship.url
                                                                                                                                                                                                        Definition

                                                                                                                                                                                                        Source of the definition for the extension code - a logical name or a URL.

                                                                                                                                                                                                        Shortidentifies the meaning of the extension
                                                                                                                                                                                                        Comments

                                                                                                                                                                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                        Typeuri
                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                        Fixed Valuehttps://standards.digital.health.nz/fhir/central-region/extn-contact-relationship
                                                                                                                                                                                                        665. Patient.contact.relationship.extension:contact-relationship.value[x]
                                                                                                                                                                                                        Definition

                                                                                                                                                                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                                                                                                                                                        ShortValue of extension
                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                        BindingThe codes SHALL be taken from NZ Central Region - NZ ContactRelationship Value Set
                                                                                                                                                                                                        (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-contact-relationship)
                                                                                                                                                                                                        TypeCoding
                                                                                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                        667. Patient.contact.relationship.extension:contact-relationship.value[x].id
                                                                                                                                                                                                        Definition

                                                                                                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                        669. Patient.contact.relationship.extension:contact-relationship.value[x].extension
                                                                                                                                                                                                        Definition

                                                                                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                                                        ShortAdditional content defined by implementations
                                                                                                                                                                                                        Comments

                                                                                                                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                                        Control0..*
                                                                                                                                                                                                        TypeExtension
                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                        SlicingThis element introduces a set of slices on Patient.contact.relationship.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                        • value @ url
                                                                                                                                                                                                        • 671. Patient.contact.relationship.extension:contact-relationship.value[x].system
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                          ShortIdentity of the terminology system
                                                                                                                                                                                                          Comments

                                                                                                                                                                                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                          Typeuri
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                          Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          673. Patient.contact.relationship.extension:contact-relationship.value[x].version
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                          ShortVersion of the system - if relevant
                                                                                                                                                                                                          Comments

                                                                                                                                                                                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          675. Patient.contact.relationship.extension:contact-relationship.value[x].code
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                          ShortSymbol in syntax defined by the system
                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                          Typecode
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                          Need to refer to a particular code in the system.

                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          677. Patient.contact.relationship.extension:contact-relationship.value[x].display
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                          ShortRepresentation defined by the system
                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          679. Patient.contact.relationship.extension:contact-relationship.value[x].userSelected
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                          ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                          Comments

                                                                                                                                                                                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                          Typeboolean
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          681. Patient.contact.relationship.coding
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                                                                                                          ShortCode defined by a terminology system
                                                                                                                                                                                                          Comments

                                                                                                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                                          Control0..*
                                                                                                                                                                                                          TypeCoding
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          683. Patient.contact.relationship.coding.id
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                          ShortUnique id for inter-element referencing
                                                                                                                                                                                                          Control0..0
                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                          685. Patient.contact.relationship.coding.extension
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          An Extension

                                                                                                                                                                                                          ShortExtension
                                                                                                                                                                                                          Control0..0
                                                                                                                                                                                                          TypeExtension
                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                          SlicingThis element introduces a set of slices on Patient.contact.relationship.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                          • value @ url
                                                                                                                                                                                                          • 687. Patient.contact.relationship.coding.system
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                            ShortIdentity of the terminology system
                                                                                                                                                                                                            Comments

                                                                                                                                                                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            689. Patient.contact.relationship.coding.version
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                            ShortVersion of the system - if relevant
                                                                                                                                                                                                            Comments

                                                                                                                                                                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            691. Patient.contact.relationship.coding.code
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                            ShortSymbol in syntax defined by the system
                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                            Typecode
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                            Need to refer to a particular code in the system.

                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            693. Patient.contact.relationship.coding.display
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                            ShortRepresentation defined by the system
                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            695. Patient.contact.relationship.coding.userSelected
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                            ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                            Comments

                                                                                                                                                                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                            Typeboolean
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            697. Patient.contact.relationship.text
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                                            ShortPlain text representation of the concept
                                                                                                                                                                                                            Comments

                                                                                                                                                                                                            Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            699. Patient.contact.name
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            A name associated with the contact person.

                                                                                                                                                                                                            ShortA name associated with the contact person
                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                            TypeHumanName
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                            Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            701. Patient.contact.name.id
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                            703. Patient.contact.name.extension
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            An Extension

                                                                                                                                                                                                            ShortExtension
                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                            SlicingThis element introduces a set of slices on Patient.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                            • value @ url
                                                                                                                                                                                                            • 705. Patient.contact.name.use
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Identifies the purpose for this name.

                                                                                                                                                                                                              Shortusual | official | temp | nickname | anonymous | old | maiden
                                                                                                                                                                                                              Comments

                                                                                                                                                                                                              Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                              BindingThe codes SHALL be taken from NameUse
                                                                                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                                                                                                                                                                              The use of a human name.

                                                                                                                                                                                                              Typecode
                                                                                                                                                                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                              Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              707. Patient.contact.name.text
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                                                                                                                                                              ShortText representation of the full name
                                                                                                                                                                                                              Comments

                                                                                                                                                                                                              Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                              A renderable, unencoded form.

                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              709. Patient.contact.name.family
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                                                                                                                                              ShortFamily name (often called 'Surname')
                                                                                                                                                                                                              Comments

                                                                                                                                                                                                              Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Alternate Namessurname
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              711. Patient.contact.name.given
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Given name.

                                                                                                                                                                                                              ShortGiven names (not always 'first'). Includes middle names
                                                                                                                                                                                                              Comments

                                                                                                                                                                                                              If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Alternate Namesfirst name, middle name
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              713. Patient.contact.name.prefix
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                                                                                                                                              ShortParts that come before the name
                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              715. Patient.contact.name.suffix
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                                                                                                                                                              ShortParts that come after the name
                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              717. Patient.contact.name.period
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Indicates the period of time when this name was valid for the named person.

                                                                                                                                                                                                              ShortTime period when name was/is in use
                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                              TypePeriod
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                              Allows names to be placed in historical context.

                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              719. Patient.contact.telecom
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              A contact detail for the person, e.g. a telephone number or an email address.

                                                                                                                                                                                                              ShortA contact detail for the person
                                                                                                                                                                                                              Comments

                                                                                                                                                                                                              Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                              TypeContactPoint
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                              People have (primary) ways to contact them in some way such as phone, email.

                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              721. Patient.contact.telecom.id
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                              723. Patient.contact.telecom.extension
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              An Extension

                                                                                                                                                                                                              ShortExtension
                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                              TypeExtension
                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                              SlicingThis element introduces a set of slices on Patient.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                              • value @ url
                                                                                                                                                                                                              • 725. Patient.contact.telecom.system
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                                                                                                                                                                Shortphone | fax | email | pager | url | sms | other
                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                This element is affected by the following invariants: cpt-2
                                                                                                                                                                                                                BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                                                                                                                                Telecommunications form for contact point.

                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                727. Patient.contact.telecom.value
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                                                                                                                                                                ShortThe actual contact point details
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                Need to support legacy numbers that are not in a tightly controlled format.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                729. Patient.contact.telecom.use
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Identifies the purpose for the contact point.

                                                                                                                                                                                                                Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                BindingThe codes SHALL be taken from ContactPointUse
                                                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                                                                                                                                                                                                Use of contact point.

                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                731. Patient.contact.telecom.rank
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                                                                                                                                ShortSpecify preferred order of use (1 = highest)
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                TypepositiveInt
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                733. Patient.contact.telecom.period
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Time period when the contact point was/is in use.

                                                                                                                                                                                                                ShortTime period when the contact point was/is in use
                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                TypePeriod
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                735. Patient.contact.address
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Address for the contact person.

                                                                                                                                                                                                                ShortAddress for the contact person
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                TypeAddress
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                Need to keep track where the contact person can be contacted per postal mail or visited.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                737. Patient.contact.gender
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                                                                                                                                                                Shortmale | female | other | unknown
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                BindingThe codes SHALL be taken from AdministrativeGender
                                                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

                                                                                                                                                                                                                The gender of a person used for administrative purposes.

                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                Needed to address the person correctly.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                739. Patient.contact.organization
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                                                                                                                                                ShortOrganization that is associated with the contact
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                This element is affected by the following invariants: pat-1
                                                                                                                                                                                                                TypeReference(Organization)
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                For guardians or business related contacts, the organization is relevant.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                741. Patient.contact.period
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                                                                                                                                                ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                TypePeriod
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                743. Patient.communication
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                A language which may be used to communicate with the patient about his or her health.

                                                                                                                                                                                                                ShortA language which may be used to communicate with the patient about his or her health
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                                                                                                                                                Control0..*
                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                745. Patient.communication.id
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                747. Patient.communication.extension
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                An Extension

                                                                                                                                                                                                                ShortExtension
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                TypeExtension
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                749. Patient.communication.modifierExtension
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                                                                                                                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                                                Control0..*
                                                                                                                                                                                                                TypeExtension
                                                                                                                                                                                                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                751. Patient.communication.language
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                                                                                                                                                                                                                ShortThe language which can be used to communicate with the patient about his or her health
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                BindingThe codes SHOULD be taken from CommonLanguages
                                                                                                                                                                                                                (preferred to http://hl7.org/fhir/ValueSet/languages)

                                                                                                                                                                                                                A human language.

                                                                                                                                                                                                                Additional BindingsPurpose
                                                                                                                                                                                                                AllLanguagesMax Binding
                                                                                                                                                                                                                NZ Central Region - Raw Language Value Value SetRequired
                                                                                                                                                                                                                TypeCodeableConcept
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                753. Patient.communication.language.id
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                755. Patient.communication.language.extension
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                An Extension

                                                                                                                                                                                                                ShortExtension
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                TypeExtension
                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                SlicingThis element introduces a set of slices on Patient.communication.language.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                • value @ url
                                                                                                                                                                                                                • 757. Patient.communication.language.coding
                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                  A reference to a code defined by a terminology system.

                                                                                                                                                                                                                  ShortCode defined by a terminology system
                                                                                                                                                                                                                  Comments

                                                                                                                                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                                                  Control0..*
                                                                                                                                                                                                                  TypeCoding
                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                  Requirements

                                                                                                                                                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                  759. Patient.communication.language.coding.id
                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                                                                                  Control0..0
                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                  761. Patient.communication.language.coding.extension
                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                  An Extension

                                                                                                                                                                                                                  ShortExtension
                                                                                                                                                                                                                  Control0..0
                                                                                                                                                                                                                  TypeExtension
                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                  SlicingThis element introduces a set of slices on Patient.communication.language.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                  • value @ url
                                                                                                                                                                                                                  • 763. Patient.communication.language.coding.system
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                                    ShortIdentity of the terminology system
                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    765. Patient.communication.language.coding.version
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    767. Patient.communication.language.coding.code
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                    Typecode
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    769. Patient.communication.language.coding.display
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                                    ShortRepresentation defined by the system
                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    771. Patient.communication.language.coding.userSelected
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                                    Typeboolean
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    773. Patient.communication.language.text
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                                                    ShortPlain text representation of the concept
                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                    Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    775. Patient.communication.preferred
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                                                                                                                                                                    ShortLanguage preference indicator
                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                    This language is specifically identified for communicating healthcare information.

                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                    Typeboolean
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                    People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    777. Patient.generalPractitioner
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    Patient's nominated care provider.

                                                                                                                                                                                                                    ShortPatient's nominated primary care provider
                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                    This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                                                                                                                                                                                                    Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                    TypeReference(Organization, Practitioner, PractitionerRole)
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                    Alternate NamescareProvider
                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    779. Patient.generalPractitioner.id
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                    781. Patient.generalPractitioner.extension
                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                    An Extension

                                                                                                                                                                                                                    ShortExtension
                                                                                                                                                                                                                    Control0..0
                                                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                    SlicingThis element introduces a set of slices on Patient.generalPractitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                                    • 783. Patient.generalPractitioner.reference
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                                                                                                                                                                      ShortLiteral reference, Relative, internal or absolute URL
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ref-1
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      785. Patient.generalPractitioner.type
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                                                                                                                                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                                                                                                                                                      ShortType the reference refers to (e.g. "Patient")
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                                                                                                                                                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                                                                                                                                                                                      Aa resource (or, for logical models, the URI of the logical model).

                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      787. Patient.generalPractitioner.identifier
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                                                                                                                                                                      ShortLogical reference, when literal reference is not known
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                                                                                                                                                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                                                                                                                                                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                                                                                                                                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                                                                                                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                      TypeIdentifier
                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      789. Patient.generalPractitioner.identifier.id
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                      Control0..0
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                      791. Patient.generalPractitioner.identifier.extension
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      An Extension

                                                                                                                                                                                                                      ShortExtension
                                                                                                                                                                                                                      Control0..0
                                                                                                                                                                                                                      TypeExtension
                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                      SlicingThis element introduces a set of slices on Patient.generalPractitioner.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                      • value @ url
                                                                                                                                                                                                                      • 793. Patient.generalPractitioner.identifier.use
                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                        The purpose of this identifier.

                                                                                                                                                                                                                        Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                        BindingThe codes SHALL be taken from IdentifierUse
                                                                                                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                                                                                                                                                        Identifies the purpose for this identifier, if known .

                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                        795. Patient.generalPractitioner.identifier.type
                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                                                                        ShortDescription of identifier
                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                                                                                                                                                        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                                                                                                                                                                                        A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                        Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                        797. Patient.generalPractitioner.identifier.type.id
                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                        Control0..0
                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                        799. Patient.generalPractitioner.identifier.type.extension
                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                        An Extension

                                                                                                                                                                                                                        ShortExtension
                                                                                                                                                                                                                        Control0..0
                                                                                                                                                                                                                        TypeExtension
                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                        SlicingThis element introduces a set of slices on Patient.generalPractitioner.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                        • value @ url
                                                                                                                                                                                                                        • 801. Patient.generalPractitioner.identifier.type.coding
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                                                                                                                          ShortCode defined by a terminology system
                                                                                                                                                                                                                          Comments

                                                                                                                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                                                          Control0..*
                                                                                                                                                                                                                          TypeCoding
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                          803. Patient.generalPractitioner.identifier.type.coding.id
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                          ShortUnique id for inter-element referencing
                                                                                                                                                                                                                          Control0..0
                                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                          805. Patient.generalPractitioner.identifier.type.coding.extension
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          An Extension

                                                                                                                                                                                                                          ShortExtension
                                                                                                                                                                                                                          Control0..0
                                                                                                                                                                                                                          TypeExtension
                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                          SlicingThis element introduces a set of slices on Patient.generalPractitioner.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                          • value @ url
                                                                                                                                                                                                                          • 807. Patient.generalPractitioner.identifier.type.coding.system
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                                            ShortIdentity of the terminology system
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                                            Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            809. Patient.generalPractitioner.identifier.type.coding.version
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                                            ShortVersion of the system - if relevant
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            811. Patient.generalPractitioner.identifier.type.coding.code
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                                            ShortSymbol in syntax defined by the system
                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                            Typecode
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            Need to refer to a particular code in the system.

                                                                                                                                                                                                                            Pattern ValueLR
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            813. Patient.generalPractitioner.identifier.type.coding.display
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                                            ShortRepresentation defined by the system
                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                                            Pattern ValueLocal Registry ID
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            815. Patient.generalPractitioner.identifier.type.coding.userSelected
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                                            ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            Typeboolean
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            817. Patient.generalPractitioner.identifier.type.text
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                                                            ShortPlain text representation of the concept
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            819. Patient.generalPractitioner.identifier.system
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                                                                                            ShortThe namespace for the identifier value
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            Identifier.system is always case sensitive.

                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                                                                                            Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-practitioner-id
                                                                                                                                                                                                                            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            821. Patient.generalPractitioner.identifier.value
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                                                                                            ShortThe value that is unique
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Example<br/><b>General</b>:123456
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            823. Patient.generalPractitioner.identifier.period
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Time period during which identifier is/was valid for use.

                                                                                                                                                                                                                            ShortTime period when id is/was valid for use
                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            TypePeriod
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            825. Patient.generalPractitioner.identifier.assigner
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Organization that issued/manages the identifier.

                                                                                                                                                                                                                            ShortOrganization that issued id (may be just text)
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            TypeReference(Organization)
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            827. Patient.generalPractitioner.display
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                                                                                                                                                            ShortText alternative for the resource
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            829. Patient.managingOrganization
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Organization that is the custodian of the patient record.

                                                                                                                                                                                                                            ShortOrganization that is the custodian of the patient record
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            TypeReference(Organization)
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            Need to know who recognizes this patient record, manages and updates it.

                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            831. Patient.link
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Link to another patient resource that concerns the same actual patient.

                                                                                                                                                                                                                            ShortLink to another patient resource that concerns the same actual person
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            There is no assumption that linked patient records have mutual links.

                                                                                                                                                                                                                            Control0..*
                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                            Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            There are multiple use cases:

                                                                                                                                                                                                                            • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                                                                                                                                                            • Distribution of patient information across multiple servers.
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            833. Patient.link.id
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                            835. Patient.link.extension
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            An Extension

                                                                                                                                                                                                                            ShortExtension
                                                                                                                                                                                                                            Control0..0
                                                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                            837. Patient.link.modifierExtension
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                                                                                                                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                                                            Control0..*
                                                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                            839. Patient.link.other
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            The other patient resource that the link refers to.

                                                                                                                                                                                                                            ShortThe other patient or related person resource that the link refers to
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                            TypeReference(Patient, RelatedPerson)
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            841. Patient.link.other.id
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                            843. Patient.link.other.extension
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                                                                                            ShortAdditional content defined by implementations
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                                                                                            Control0..*
                                                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                            SlicingThis element introduces a set of slices on Patient.link.other.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                            • value @ url
                                                                                                                                                                                                                            • 845. Patient.link.other.reference
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                                                                                                                                                                              ShortLiteral reference, Relative, internal or absolute URL
                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                                              This element is affected by the following invariants: ref-1
                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                              847. Patient.link.other.type
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                                                                                                                                                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                                                                                                                                                              ShortPatient
                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                                                                                                                                                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                                                                                                                                                                                              Aa resource (or, for logical models, the URI of the logical model).

                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                              Pattern ValuePatient
                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                              849. Patient.link.other.identifier
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                                                                                                                                                                              ShortBusiness-level identifier for the Patient being replaced
                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                                                                                                                                                                              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                                                                                                                                                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                                                                                                                                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                                                                                                                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                              TypeIdentifier
                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                              851. Patient.link.other.display
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                                                                                                                                                              ShortText alternative for the resource
                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                              This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                              853. Patient.link.type
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              The type of link between this patient resource and another patient resource.

                                                                                                                                                                                                                              Shortreplaced-by | replaces
                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                              BindingThe codes SHALL be taken from LinkType
                                                                                                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                                                                                                                                                                                                              The type of link between this patient resource and another patient resource.

                                                                                                                                                                                                                              Typecode
                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))