Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
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
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 | |||||||
Control | 1..? | ||||||
6. Patient.meta.extension:hl7v2Message | |||||||
Slice Name | hl7v2Message | ||||||
Control | 1..1 | ||||||
Type | Extension(HL7 v2 Message) (Extension Type: base64Binary) | ||||||
Must Support | true | ||||||
8. Patient.meta.extension:hl7v2Message.url | |||||||
10. Patient.meta.extension:hl7v2Message.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
12. Patient.meta.extension:process-timestamp | |||||||
Slice Name | process-timestamp | ||||||
Control | 0..1 | ||||||
Type | Extension(Process TimeStamp) (Extension Type: dateTime) | ||||||
Must Support | true | ||||||
14. Patient.meta.extension:source-event-trigger | |||||||
Slice Name | source-event-trigger | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Event Trigger) (Extension Type: CodeableConcept) | ||||||
Must Support | true | ||||||
16. Patient.meta.extension:source-record-type | |||||||
Slice Name | source-record-type | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Record Type) (Extension Type: CodeableConcept) | ||||||
Must Support | true | ||||||
18. Patient.meta.extension:source-record-id | |||||||
Slice Name | source-record-id | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Record ID) (Extension Type: string) | ||||||
Must Support | true | ||||||
20. Patient.meta.extension:source-data-mode-version | |||||||
Slice Name | source-data-mode-version | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Data Model Version) (Extension Type: string) | ||||||
Must Support | true | ||||||
22. Patient.meta.extension:process-client-id | |||||||
Slice Name | process-client-id | ||||||
Control | 0..1 | ||||||
Type | Extension(Process Client ID) (Extension Type: string) | ||||||
Must Support | true | ||||||
24. Patient.meta.extension:l4h-template-version | |||||||
Slice Name | l4h-template-version | ||||||
Control | 0..1 | ||||||
Type | Extension(L4H Template Version) (Extension Type: string) | ||||||
Must Support | true | ||||||
26. Patient.implicitRules | |||||||
Control | 0..0 | ||||||
28. Patient.language | |||||||
Control | 0..0 | ||||||
30. Patient.contained | |||||||
Control | 0..0 | ||||||
32. Patient.extension:ethnicity | |||||||
Slice Name | ethnicity | ||||||
34. Patient.extension:ethnicity.url | |||||||
36. Patient.extension:ethnicity.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice 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 Name | nzCitizen | ||||||
Must Support | true | ||||||
48. Patient.extension:nzCitizen.id | |||||||
Control | 0..0 | ||||||
50. Patient.extension:nzCitizen.extension | |||||||
Control | 1..? | ||||||
52. Patient.extension:nzCitizen.extension:status | |||||||
Slice Name | status | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
54. Patient.extension:nzCitizen.extension:status.id | |||||||
Control | 0..0 | ||||||
56. Patient.extension:nzCitizen.extension:status.url | |||||||
58. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
60. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.id | |||||||
Short | Is this person a New Zealand citizen? CodeableConcept: yes / no / unknown | ||||||
Control | 0..0 | ||||||
62. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding | |||||||
Control | 1..1 | ||||||
Must Support | true | ||||||
64. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
66. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
68. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
70. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
72. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding.userSelected | |||||||
Control | 0..0 | ||||||
74. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.text | |||||||
Control | 0..0 | ||||||
76. Patient.extension:nzCitizen.extension:source | |||||||
Slice Name | source | ||||||
Control | 0..0 | ||||||
78. Patient.extension:nzCitizen.url | |||||||
80. Patient.extension:dhb | |||||||
Slice Name | dhb | ||||||
Must Support | true | ||||||
82. Patient.extension:dhb.id | |||||||
Control | 0..0 | ||||||
84. Patient.extension:dhb.url | |||||||
86. Patient.extension:dhb.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
88. Patient.extension:dhb.value[x].coding | |||||||
Control | 1..1 | ||||||
Must Support | true | ||||||
90. Patient.extension:dhb.value[x].coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
92. Patient.extension:dhb.value[x].coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
94. Patient.extension:dhb.value[x].coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
96. Patient.extension:dhb.value[x].coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
98. Patient.extension:dhb.value[x].coding.userSelected | |||||||
Control | 0..0 | ||||||
100. Patient.extension:dhb.value[x].text | |||||||
Control | 0..0 | ||||||
102. Patient.extension:domicile-code | |||||||
Slice Name | domicile-code | ||||||
Must Support | true | ||||||
104. Patient.extension:domicile-code.id | |||||||
Control | 0..0 | ||||||
106. Patient.extension:domicile-code.url | |||||||
108. Patient.extension:domicile-code.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
110. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding | |||||||
Control | 1..1 | ||||||
Must Support | true | ||||||
112. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
114. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
116. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
118. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.display | |||||||
Must Support | true | ||||||
120. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected | |||||||
Control | 0..0 | ||||||
122. Patient.extension:domicile-code.value[x]:valueCodeableConcept.text | |||||||
Control | 0..0 | ||||||
124. Patient.extension:pho | |||||||
Slice Name | pho | ||||||
Control | 0..0 | ||||||
126. Patient.extension:sex-at-birth | |||||||
Slice Name | sex-at-birth | ||||||
Control | 0..0 | ||||||
128. Patient.extension:iwi | |||||||
Slice Name | iwi | ||||||
Control | 0..0 | ||||||
130. Patient.extension:nzcrEthnicity | |||||||
Slice Name | nzcrEthnicity | ||||||
Control | 0..3 | ||||||
Type | Extension(NZ Ethnicity (Central Region Edition)) (Extension Type: CodeableConcept) | ||||||
Must Support | true | ||||||
132. Patient.extension:nzcrEthnicity.id | |||||||
Control | 0..0 | ||||||
134. Patient.extension:nzcrEthnicity.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
136. Patient.extension:nzcrEthnicity.value[x].coding | |||||||
Control | 2..? | ||||||
Must Support | true | ||||||
Slicing | This 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: | ||||||
138. Patient.extension:nzcrEthnicity.value[x].coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
140. Patient.extension:nzcrEthnicity.value[x].coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
142. Patient.extension:nzcrEthnicity.value[x].coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
144. Patient.extension:nzcrEthnicity.value[x].coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
146. Patient.extension:nzcrEthnicity.value[x].coding.userSelected | |||||||
Control | 0..0 | ||||||
148. Patient.extension:nzcrEthnicity.value[x].coding:level2 | |||||||
Slice Name | level2 | ||||||
Control | 1..1 | ||||||
150. Patient.extension:nzcrEthnicity.value[x].coding:level2.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Fixed Value | https://standards.digital.health.nz/ns/ethnic-group-level-2-code | ||||||
152. Patient.extension:nzcrEthnicity.value[x].coding:level2.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
154. Patient.extension:nzcrEthnicity.value[x].coding:level2.code | |||||||
Control | 1..? | ||||||
Binding | The 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 Support | true | ||||||
156. Patient.extension:nzcrEthnicity.value[x].coding:level2.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
158. Patient.extension:nzcrEthnicity.value[x].coding:level2.userSelected | |||||||
Control | 0..0 | ||||||
160. Patient.extension:nzcrEthnicity.value[x].coding:level4 | |||||||
Slice Name | level4 | ||||||
Control | 1..1 | ||||||
162. Patient.extension:nzcrEthnicity.value[x].coding:level4.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Fixed Value | https://standards.digital.health.nz/ns/ethnic-group-level-4-code | ||||||
164. Patient.extension:nzcrEthnicity.value[x].coding:level4.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
166. Patient.extension:nzcrEthnicity.value[x].coding:level4.code | |||||||
Control | 1..? | ||||||
Binding | The codes SHALL be taken from Ethnicity of a person (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code ) | ||||||
Must Support | true | ||||||
168. Patient.extension:nzcrEthnicity.value[x].coding:level4.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
170. Patient.extension:nzcrEthnicity.value[x].coding:level4.userSelected | |||||||
Control | 0..0 | ||||||
172. Patient.extension:nzcrEthnicity.value[x].text | |||||||
Control | 0..0 | ||||||
174. Patient.extension:nzcrResidency | |||||||
Slice Name | nzcrResidency | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Residency (Central Region Edition)) (Complex Extension) | ||||||
Must Support | true | ||||||
176. Patient.extension:nzcrResidency.id | |||||||
Control | 0..0 | ||||||
178. Patient.extension:nzcrResidency.extension:status | |||||||
Slice Name | status | ||||||
180. Patient.extension:nzcrResidency.extension:status.id | |||||||
Control | 0..0 | ||||||
182. Patient.extension:nzcrResidency.extension:status.url | |||||||
184. Patient.extension:nzcrResidency.extension:status.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
186. Patient.extension:nzcrResidency.extension:status.value[x].coding | |||||||
Control | 2..? | ||||||
Must Support | true | ||||||
Slicing | This 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: | ||||||
188. Patient.extension:nzcrResidency.extension:status.value[x].coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
190. Patient.extension:nzcrResidency.extension:status.value[x].coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
192. Patient.extension:nzcrResidency.extension:status.value[x].coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
194. Patient.extension:nzcrResidency.extension:status.value[x].coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
196. Patient.extension:nzcrResidency.extension:status.value[x].coding.userSelected | |||||||
Control | 0..0 | ||||||
198. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase | |||||||
Slice Name | nzBase | ||||||
Control | 1..1 | ||||||
200. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Pattern Value | https://standards.digital.health.nz/ns/nz-residency-code | ||||||
202. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
204. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code | |||||||
Control | 1..? | ||||||
Binding | The codes SHALL be taken from NZ Residency status (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code ) | ||||||
Must Support | true | ||||||
206. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
208. Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.userSelected | |||||||
Control | 0..0 | ||||||
210. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource | |||||||
Slice Name | rawSource | ||||||
Control | 1..1 | ||||||
212. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Fixed Value | https://standards.digital.health.nz/ns/central-region/nz-residency-code | ||||||
214. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
216. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code | |||||||
Control | 1..? | ||||||
Binding | The 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 Support | true | ||||||
218. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
220. Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.userSelected | |||||||
Control | 0..0 | ||||||
222. Patient.extension:nzcrResidency.extension:status.value[x].text | |||||||
Control | 0..0 | ||||||
224. Patient.extension:nzcrResidency.extension:source | |||||||
Slice Name | source | ||||||
Control | 0..0 | ||||||
226. Patient.extension:nzcrResidency.url | |||||||
228. Patient.extension:nzcrReligion | |||||||
Slice Name | nzcrReligion | ||||||
Control | 0..1 | ||||||
Type | Extension(Religious Affiliation (Central Region Edition)) (Extension Type: CodeableConcept) | ||||||
Must Support | true | ||||||
230. Patient.extension:nzcrReligion.url | |||||||
232. Patient.extension:nzcrReligion.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
234. Patient.extension:nzcrReligion.value[x].id | |||||||
Control | 0..0 | ||||||
236. Patient.extension:nzcrReligion.value[x].coding | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Slicing | This 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: | ||||||
238. Patient.extension:nzcrReligion.value[x].coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
240. Patient.extension:nzcrReligion.value[x].coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
242. Patient.extension:nzcrReligion.value[x].coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
244. Patient.extension:nzcrReligion.value[x].coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
246. Patient.extension:nzcrReligion.value[x].coding.userSelected | |||||||
Control | 0..0 | ||||||
248. Patient.extension:nzcrReligion.value[x].coding:origFhir | |||||||
Slice Name | origFhir | ||||||
Control | 0..1 | ||||||
250. Patient.extension:nzcrReligion.value[x].coding:origFhir.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation | ||||||
252. Patient.extension:nzcrReligion.value[x].coding:origFhir.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
254. Patient.extension:nzcrReligion.value[x].coding:origFhir.code | |||||||
Control | 1..? | ||||||
Binding | The codes SHALL be taken from ReligiousAffiliation (required to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation ) | ||||||
Must Support | true | ||||||
256. Patient.extension:nzcrReligion.value[x].coding:origFhir.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
258. Patient.extension:nzcrReligion.value[x].coding:origFhir.userSelected | |||||||
Control | 0..0 | ||||||
260. Patient.extension:nzcrReligion.value[x].coding:rawSource | |||||||
Slice Name | rawSource | ||||||
Control | 1..1 | ||||||
262. Patient.extension:nzcrReligion.value[x].coding:rawSource.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Fixed Value | https://standards.digital.health.nz/ns/central-region/patient-religion | ||||||
264. Patient.extension:nzcrReligion.value[x].coding:rawSource.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
266. Patient.extension:nzcrReligion.value[x].coding:rawSource.code | |||||||
Control | 1..? | ||||||
Binding | The 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 Support | true | ||||||
268. Patient.extension:nzcrReligion.value[x].coding:rawSource.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
270. Patient.extension:nzcrReligion.value[x].coding:rawSource.userSelected | |||||||
Control | 0..0 | ||||||
272. Patient.extension:nzcrReligion.value[x].text | |||||||
Control | 0..0 | ||||||
274. Patient.extension:interpreterRequired | |||||||
Slice Name | interpreterRequired | ||||||
Control | 0..1 | ||||||
Type | Extension(Patient Interpreter Required) (Extension Type: boolean) | ||||||
Must Support | true | ||||||
276. Patient.extension:interpreterRequired.url | |||||||
278. Patient.extension:interpreterRequired.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
280. Patient.identifier | |||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
282. Patient.identifier.id | |||||||
Control | 0..0 | ||||||
284. Patient.identifier.extension | |||||||
Control | 0..0 | ||||||
286. Patient.identifier.use | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
288. Patient.identifier.type | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
290. Patient.identifier.type.coding | |||||||
Must Support | true | ||||||
292. Patient.identifier.type.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
294. Patient.identifier.type.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
296. Patient.identifier.type.coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
298. Patient.identifier.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
300. Patient.identifier.value | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
302. Patient.identifier.period | |||||||
Control | 0..0 | ||||||
304. Patient.identifier.assigner | |||||||
Control | 0..0 | ||||||
306. Patient.identifier:NHI | |||||||
Slice Name | NHI | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
308. Patient.identifier:NHI.id | |||||||
Control | 0..0 | ||||||
310. Patient.identifier:NHI.extension | |||||||
Control | 0..0 | ||||||
312. Patient.identifier:NHI.use | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
314. Patient.identifier:NHI.type | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
316. Patient.identifier:NHI.system | |||||||
Must Support | true | ||||||
318. Patient.identifier:NHI.value | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
320. Patient.identifier:NHI.period | |||||||
Control | 0..0 | ||||||
322. Patient.identifier:NHI.assigner | |||||||
Control | 0..0 | ||||||
324. Patient.name | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
326. Patient.name.id | |||||||
Control | 0..0 | ||||||
328. Patient.name.extension | |||||||
Control | 0..0 | ||||||
330. Patient.name.use | |||||||
Short | one of: usual / old | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
332. Patient.name.text | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
334. Patient.name.family | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
336. Patient.name.given | |||||||
Must Support | true | ||||||
338. Patient.name.prefix | |||||||
Must Support | true | ||||||
340. Patient.name.suffix | |||||||
Control | 0..0 | ||||||
342. Patient.telecom | |||||||
Must Support | true | ||||||
344. Patient.telecom.id | |||||||
Control | 0..0 | ||||||
346. Patient.telecom.extension | |||||||
Control | 0..0 | ||||||
348. Patient.telecom.extension:cp-purpose | |||||||
Slice Name | cp-purpose | ||||||
Control | 0..0 | ||||||
350. Patient.telecom.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
352. Patient.telecom.value | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
354. Patient.telecom.use | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
356. Patient.telecom.rank | |||||||
Control | 0..0 | ||||||
358. Patient.telecom.period | |||||||
Control | 0..0 | ||||||
360. Patient.gender | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
362. Patient.birthDate | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
LOINC Code | |||||||
364. Patient.deceased[x] | |||||||
Short | deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known | ||||||
Control | 1..? | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Must Support | true | ||||||
Slicing | This element introduces a set of slices on Patient.deceased[x] . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
366. Patient.deceased[x]:deceasedDateTime | |||||||
Slice Name | deceasedDateTime | ||||||
Control | 0..1 | ||||||
Type | dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
368. Patient.deceased[x]:deceasedBoolean | |||||||
Slice Name | deceasedBoolean | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
370. Patient.address | |||||||
Must Support | true | ||||||
372. Patient.address.id | |||||||
Control | 0..0 | ||||||
374. Patient.address.extension:nz-geocode | |||||||
Slice Name | nz-geocode | ||||||
Control | 0..0 | ||||||
376. Patient.address.extension:suburb | |||||||
Slice Name | suburb | ||||||
Must Support | true | ||||||
378. Patient.address.extension:suburb.url | |||||||
380. Patient.address.extension:suburb.value[x] | |||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
382. Patient.address.extension:building-name | |||||||
Slice Name | building-name | ||||||
Control | 0..0 | ||||||
384. Patient.address.extension:domicile-code | |||||||
Slice Name | domicile-code | ||||||
Must Support | true | ||||||
386. Patient.address.extension:domicile-code.id | |||||||
Control | 0..0 | ||||||
388. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
390. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding | |||||||
Control | 1..1 | ||||||
Must Support | true | ||||||
392. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
394. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
396. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
398. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.display | |||||||
Must Support | true | ||||||
400. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding.userSelected | |||||||
Control | 0..0 | ||||||
402. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.text | |||||||
Control | 0..0 | ||||||
404. Patient.address.use | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
406. Patient.address.type | |||||||
Short | PHYSICAL | POSTAL | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
408. Patient.address.text | |||||||
Control | 0..0 | ||||||
410. Patient.address.line | |||||||
Control | 0..2 | ||||||
Must Support | true | ||||||
412. Patient.address.city | |||||||
Must Support | true | ||||||
414. Patient.address.district | |||||||
Control | 0..0 | ||||||
416. Patient.address.state | |||||||
Must Support | true | ||||||
418. Patient.address.postalCode | |||||||
Must Support | true | ||||||
420. Patient.address.country | |||||||
Must Support | true | ||||||
422. Patient.address.period | |||||||
Control | 0..0 | ||||||
424. Patient.maritalStatus | |||||||
Control | 1..? | ||||||
Binding | The 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 Support | true | ||||||
426. Patient.maritalStatus.id | |||||||
Control | 0..0 | ||||||
428. Patient.maritalStatus.extension | |||||||
Control | 0..0 | ||||||
430. Patient.maritalStatus.coding | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
432. Patient.maritalStatus.coding.id | |||||||
Control | 0..0 | ||||||
434. Patient.maritalStatus.coding.extension | |||||||
Control | 0..0 | ||||||
436. Patient.maritalStatus.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
438. Patient.maritalStatus.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
440. Patient.maritalStatus.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
442. Patient.maritalStatus.coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
444. Patient.maritalStatus.coding.userSelected | |||||||
Control | 0..0 | ||||||
446. Patient.maritalStatus.text | |||||||
Control | 0..0 | ||||||
448. Patient.multipleBirth[x] | |||||||
Control | 0..0 | ||||||
450. Patient.photo | |||||||
Control | 0..0 | ||||||
452. Patient.contact | |||||||
Must Support | true | ||||||
454. Patient.contact.id | |||||||
Control | 0..0 | ||||||
456. Patient.contact.extension | |||||||
Control | 0..0 | ||||||
458. Patient.contact.relationship | |||||||
Control | 1..1 | ||||||
Must Support | true | ||||||
460. Patient.contact.relationship.id | |||||||
Control | 0..0 | ||||||
462. Patient.contact.relationship.extension:contact-relationship | |||||||
Slice Name | contact-relationship | ||||||
Control | 0..1 | ||||||
Type | Extension(Contact Relationship) (Extension Type: Coding) | ||||||
Must Support | true | ||||||
464. Patient.contact.relationship.extension:contact-relationship.value[x] | |||||||
[x] Note | SeeChoice 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 | |||||||
Control | 0..0 | ||||||
476. Patient.contact.relationship.coding.extension | |||||||
Control | 0..0 | ||||||
478. Patient.contact.relationship.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
480. Patient.contact.relationship.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
482. Patient.contact.relationship.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
484. Patient.contact.relationship.coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
486. Patient.contact.relationship.coding.userSelected | |||||||
Control | 0..0 | ||||||
488. Patient.contact.relationship.text | |||||||
Control | 0..0 | ||||||
490. Patient.contact.name | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
492. Patient.contact.name.id | |||||||
Control | 0..0 | ||||||
494. Patient.contact.name.extension | |||||||
Control | 0..0 | ||||||
496. Patient.contact.name.use | |||||||
Control | 0..0 | ||||||
498. Patient.contact.name.text | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
500. Patient.contact.name.family | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
502. Patient.contact.name.given | |||||||
Must Support | true | ||||||
504. Patient.contact.name.prefix | |||||||
Control | 0..1 | ||||||
Must Support | true | ||||||
506. Patient.contact.name.suffix | |||||||
Control | 0..0 | ||||||
508. Patient.contact.telecom | |||||||
Must Support | true | ||||||
510. Patient.contact.telecom.id | |||||||
Control | 0..0 | ||||||
512. Patient.contact.telecom.extension | |||||||
Control | 0..0 | ||||||
514. Patient.contact.telecom.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
516. Patient.contact.telecom.value | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
518. Patient.contact.telecom.use | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
520. Patient.contact.telecom.rank | |||||||
Control | 0..0 | ||||||
522. Patient.contact.address | |||||||
Control | 0..0 | ||||||
524. Patient.contact.gender | |||||||
Control | 0..0 | ||||||
526. Patient.contact.organization | |||||||
Control | 0..0 | ||||||
528. Patient.contact.period | |||||||
Must Support | true | ||||||
530. Patient.communication | |||||||
Must Support | true | ||||||
532. Patient.communication.id | |||||||
Control | 0..0 | ||||||
534. Patient.communication.extension | |||||||
Control | 0..0 | ||||||
536. Patient.communication.language | |||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Must Support | true | ||||||
538. Patient.communication.language.id | |||||||
Control | 0..0 | ||||||
540. Patient.communication.language.extension | |||||||
Control | 0..0 | ||||||
542. Patient.communication.language.coding | |||||||
544. Patient.communication.language.coding.id | |||||||
Control | 0..0 | ||||||
546. Patient.communication.language.coding.extension | |||||||
Control | 0..0 | ||||||
548. Patient.communication.language.coding.system | |||||||
Must Support | true | ||||||
550. Patient.communication.language.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
552. Patient.communication.language.coding.code | |||||||
Must Support | true | ||||||
554. Patient.communication.language.coding.display | |||||||
Must Support | true | ||||||
556. Patient.communication.language.coding.userSelected | |||||||
Control | 0..0 | ||||||
558. Patient.communication.preferred | |||||||
Must Support | true | ||||||
560. Patient.generalPractitioner | |||||||
Control | 0..1 | ||||||
Must Support | true | ||||||
562. Patient.generalPractitioner.id | |||||||
Control | 0..0 | ||||||
564. Patient.generalPractitioner.extension | |||||||
Control | 0..0 | ||||||
566. Patient.generalPractitioner.reference | |||||||
Must Support | true | ||||||
568. Patient.generalPractitioner.type | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
570. Patient.generalPractitioner.identifier | |||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
572. Patient.generalPractitioner.identifier.id | |||||||
Control | 0..0 | ||||||
574. Patient.generalPractitioner.identifier.extension | |||||||
Control | 0..0 | ||||||
576. Patient.generalPractitioner.identifier.use | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
578. Patient.generalPractitioner.identifier.type | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
580. Patient.generalPractitioner.identifier.type.id | |||||||
Control | 0..0 | ||||||
582. Patient.generalPractitioner.identifier.type.extension | |||||||
Control | 0..0 | ||||||
584. Patient.generalPractitioner.identifier.type.coding | |||||||
Must Support | true | ||||||
586. Patient.generalPractitioner.identifier.type.coding.id | |||||||
Control | 0..0 | ||||||
588. Patient.generalPractitioner.identifier.type.coding.extension | |||||||
Control | 0..0 | ||||||
590. Patient.generalPractitioner.identifier.type.coding.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Pattern Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||
592. Patient.generalPractitioner.identifier.type.coding.version | |||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
594. Patient.generalPractitioner.identifier.type.coding.code | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Pattern Value | LR | ||||||
596. Patient.generalPractitioner.identifier.type.coding.display | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Pattern Value | Local Registry ID | ||||||
598. Patient.generalPractitioner.identifier.type.coding.userSelected | |||||||
Control | 0..0 | ||||||
600. Patient.generalPractitioner.identifier.type.text | |||||||
Control | 0..0 | ||||||
602. Patient.generalPractitioner.identifier.system | |||||||
Control | 1..? | ||||||
Must Support | true | ||||||
Pattern Value | https://standards.digital.health.nz/ns/central-region/pas-practitioner-id | ||||||
604. Patient.generalPractitioner.identifier.value | |||||||
606. Patient.generalPractitioner.identifier.period | |||||||
Control | 0..0 | ||||||
608. Patient.generalPractitioner.identifier.assigner | |||||||
Control | 0..0 | ||||||
610. Patient.generalPractitioner.display | |||||||
Must Support | true | ||||||
612. Patient.managingOrganization | |||||||
Control | 0..0 | ||||||
614. Patient.link | |||||||
Must Support | true | ||||||
616. Patient.link.id | |||||||
Control | 0..0 | ||||||
618. Patient.link.extension | |||||||
Control | 0..0 | ||||||
620. Patient.link.other | |||||||
Must Support | true | ||||||
622. Patient.link.other.reference | |||||||
Control | 0..0 | ||||||
624. Patient.link.other.type | |||||||
Short | Patient | ||||||
Must Support | true | ||||||
Pattern Value | Patient | ||||||
626. Patient.link.other.identifier | |||||||
Short | Business-level identifier for the Patient being replaced | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..? | ||||||
Must Support | true | ||||||
628. Patient.link.other.display | |||||||
Control | 0..0 | ||||||
630. Patient.link.type | |||||||
Short | replaced-by | replaces | ||||||
Must Support | true |
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. | ||||||
Short | Information about an individual or animal receiving health care services | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | SubjectOfCare Client Resident | ||||||
Invariants | dom-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. | ||||||
Short | Metadata about the resource | ||||||
Control | 0..1 | ||||||
Type | Meta | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 10..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.meta.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
6. Patient.meta.extension:hl7v2Message | |||||||
Slice Name | hl7v2Message | ||||||
Definition | Base64 encoded string containing the original HL7 v2 message that was used to create / update the FHIR resource | ||||||
Short | HL7 v2 Message | ||||||
Control | 1..1 | ||||||
Type | Extension(HL7 v2 Message) (Extension Type: base64Binary) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.meta.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
10. Patient.meta.extension:hl7v2Message.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | base64Binary, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
14. Patient.meta.extension:process-timestamp | |||||||
Slice Name | process-timestamp | ||||||
Definition | Date and time the source HL7v2 message was translated into FHIR Resource | ||||||
Short | Process TimeStamp | ||||||
Control | 0..1 | ||||||
Type | Extension(Process TimeStamp) (Extension Type: dateTime) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
16. Patient.meta.extension:source-event-trigger | |||||||
Slice Name | source-event-trigger | ||||||
Definition | The HL7v2 message/event trigger that was translated into FHIR Resource (eg A31, I13, etc) | ||||||
Short | Source Event Trigger | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Event Trigger) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
18. Patient.meta.extension:source-record-type | |||||||
Slice Name | source-record-type | ||||||
Definition | The HL7v2 record type that was translated into FHIR Resource (eg ADT, REF, etc) | ||||||
Short | Source Record Type | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Record Type) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
20. Patient.meta.extension:source-record-id | |||||||
Slice Name | source-record-id | ||||||
Definition | The HL7v2 record ID that was translated into FHIR Resource | ||||||
Short | Source Record ID | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Record ID) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
22. Patient.meta.extension:source-data-mode-version | |||||||
Slice Name | source-data-mode-version | ||||||
Definition | The HL7v2 version number for the message/event that was translated into FHIR Resource | ||||||
Short | Source Data Model Version | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Data Model Version) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
24. Patient.meta.extension:process-client-id | |||||||
Slice Name | process-client-id | ||||||
Definition | The HL7v2 Source Client Id for the message/event that was translated into FHIR Resource | ||||||
Short | Process Client ID | ||||||
Control | 0..1 | ||||||
Type | Extension(Process Client ID) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
26. Patient.meta.extension:l4h-template-version | |||||||
Slice Name | l4h-template-version | ||||||
Definition | The version number of the l4h templates used to translate the hl7v2 message into FHIR Resource | ||||||
Short | L4H Template Version | ||||||
Control | 0..1 | ||||||
Type | Extension(L4H Template Version) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | A 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. | ||||||
Control | 0..01 | ||||||
Type | uri | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Language 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). | ||||||
Control | 0..01 | ||||||
Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Contained, 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. | ||||||
Control | 0..0* | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||
34. Patient.extension:ethnicity | |||||||
Slice Name | ethnicity | ||||||
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. | ||||||
Short | NZ Ethnicity | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(NZ Ethnicity) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() )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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
38. Patient.extension:ethnicity.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 10..1 | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
42. Patient.extension:ethnicity.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
44. Patient.extension:nzCitizen | |||||||
Slice Name | nzCitizen | ||||||
Definition | New Zealand citizenship | ||||||
Short | NZ Citizenship | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(NZ Citizenship) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 10..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
50. Patient.extension:nzCitizen.extension:status | |||||||
Slice Name | status | ||||||
Definition | An Extension | ||||||
Short | ExtensionAdditional content defined by implementations | ||||||
Control | 10..1* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
56. Patient.extension:nzCitizen.extension:status.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | status | ||||||
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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This 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: | ||||||
60. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from For codes, see NZ Citizenship status (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Is this person a New Zealand citizen? CodeableConcept: yes / no / unknownUnique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
64. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
78. Patient.extension:nzCitizen.extension:source | |||||||
Slice Name | source | ||||||
Definition | An Extension | ||||||
Short | ExtensionAdditional content defined by implementations | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
84. Patient.extension:nzCitizen.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 0..01 | ||||||
Type | Choice 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 Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
88. Patient.extension:dhb | |||||||
Slice Name | dhb | ||||||
Definition | District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). | ||||||
Short | District Health Board linked to a NZ Healthcare Service, Location or Patient | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() )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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
94. Patient.extension:dhb.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | NZ District Health BoardsValue of extension | ||||||
Control | 0..1 | ||||||
Binding | Unless 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 | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
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. | ||||||
Label | DHB 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" }] } | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
112. Patient.extension:domicile-code | |||||||
Slice Name | domicile-code | ||||||
Definition | NZ Domicile Code. Derived from a patient's primary physical, home address. | ||||||
Short | NZ Domicile Code | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(NZ Domicile Code) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() )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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
118. Patient.extension:domicile-code.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
122. Patient.extension:domicile-code.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from For codes, see Domicile Code (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
138. Patient.extension:pho | |||||||
Slice Name | pho | ||||||
Definition | Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP). | ||||||
Short | Primary Healthcare Organisation | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Primary Healthcare Organisation) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
140. Patient.extension:sex-at-birth | |||||||
Slice Name | sex-at-birth | ||||||
Definition | A person’s sex at the time of their birth (considered to be immutable). | ||||||
Short | Sex At Birth | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Sex At Birth) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
142. Patient.extension:iwi | |||||||
Slice Name | iwi | ||||||
Definition | Persons Iwi affiliation | ||||||
Short | Extension | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Nz_iwi) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
144. Patient.extension:nzcrEthnicity | |||||||
Slice Name | nzcrEthnicity | ||||||
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. | ||||||
Short | NZ Ethnicity (Central Region Edition) | ||||||
Control | 0..3 | ||||||
Type | Extension(NZ Ethnicity (Central Region Edition)) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
150. Patient.extension:nzcrEthnicity.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 20..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | level2 | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/ethnic-group-level-2-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | level4 | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/ethnic-group-level-4-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
192. Patient.extension:nzcrResidency | |||||||
Slice Name | nzcrResidency | ||||||
Definition | NZ Residency status, permits multiple codings from different CodeSystems | ||||||
Short | NZ Residency (Central Region Edition) | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Residency (Central Region Edition)) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
196. Patient.extension:nzcrResidency.extension:status | |||||||
Slice Name | status | ||||||
Definition | An Extension | ||||||
Short | ExtensionAdditional content defined by implementations | ||||||
Control | 0..1* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
202. Patient.extension:nzcrResidency.extension:status.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | status | ||||||
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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 20..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | nzBase | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Pattern Value | https://standards.digital.health.nz/ns/nz-residency-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Binding | The codes SHALL be taken from For codes, see NZ Residency status (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | rawSource | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/central-region/nz-residency-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
244. Patient.extension:nzcrResidency.extension:source | |||||||
Slice Name | source | ||||||
Definition | An Extension | ||||||
Short | ExtensionAdditional content defined by implementations | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
248. Patient.extension:nzcrResidency.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 0..01 | ||||||
Type | Choice 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 Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
252. Patient.extension:nzcrReligion | |||||||
Slice Name | nzcrReligion | ||||||
Definition | Patient religious affiliation extension, permits multiple codings from different CodeSystems | ||||||
Short | Religious Affiliation (Central Region Edition) | ||||||
Control | 0..1 | ||||||
Type | Extension(Religious Affiliation (Central Region Edition)) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
256. Patient.extension:nzcrReligion.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
262. Patient.extension:nzcrReligion.value[x].coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | origFhir | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Binding | The codes SHALL be taken from For codes, see ReligiousAffiliation (required to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | rawSource | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/central-region/patient-religion | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
300. Patient.extension:interpreterRequired | |||||||
Slice Name | interpreterRequired | ||||||
Definition | This Patient requires an interpreter to communicate healthcare information to the practitioner. | ||||||
Short | Whether 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. | ||||||
Control | 0..1 | ||||||
Type | Extension(Patient Interpreter Required) (Extension Type: boolean) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() )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()) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
304. Patient.extension:interpreterRequired.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 10..1 This element is affected by the following invariants: ext-1 | ||||||
Type | boolean, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Summary | false | ||||||
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 Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
310. Patient.identifier | |||||||
Definition | An identifier for this patient. | ||||||
Short | An identifier for this patient | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 10..* | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
316. Patient.identifier.use | |||||||
Definition | The purpose of this identifier. | ||||||
Short | usual | official | temp | secondary | old (If known) | ||||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||||
Control | 10..1 | ||||||
Binding | The 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 . | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Description 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. | ||||||
Control | 10..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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. | ||||||
Short | The namespace for the identifier value | ||||||
Comments | Identifier.system is always case sensitive. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 | ||||||
Invariants | ele-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. | ||||||
Short | The 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. | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:123456 | ||||||
Invariants | ele-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. | ||||||
Short | Time period when id is/was valid for use | ||||||
Control | 0..01 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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. | ||||||
Control | 0..01 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
336. Patient.identifier:NHI | |||||||
Slice Name | NHI | ||||||
Definition | An identifier for this patient. | ||||||
Short | An identifier for this patient | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
342. Patient.identifier:NHI.use | |||||||
Definition | The purpose of this identifier. | ||||||
Short | usual | official | temp | secondary | old (If known) | ||||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Description 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. | ||||||
Control | 10..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||||
Invariants | ele-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. | ||||||
Short | The namespace for the identifier value | ||||||
Comments | Identifier.system is always case sensitive. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 Value | https://standards.digital.health.nz/ns/nhi-id | ||||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||||
Invariants | ele-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. | ||||||
Short | The 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. | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:123456 | ||||||
Invariants | ele-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. | ||||||
Short | Time period when id is/was valid for use | ||||||
Control | 0..01 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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. | ||||||
Control | 0..01 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Whether 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 10..* | ||||||
Type | HumanName | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
362. Patient.name.use | |||||||
Definition | Identifies the purpose for this name. | ||||||
Short | one 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. | ||||||
Control | 10..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Invariants | ele-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. | ||||||
Short | Family name (often called 'Surname') | ||||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | surname | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
368. Patient.name.given | |||||||
Definition | Given name. | ||||||
Short | Given 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. | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | first name, middle name | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come before the name | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come after the name | ||||||
Control | 0..0* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Details 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). | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | ContactPoint(Common NZ ContactPoint datatype) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||
Invariants | cpt-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.telecom.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
380. Patient.telecom.extension:cp-purpose | |||||||
Slice Name | cp-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. | ||||||
Short | A specific purpose for which this ContactPoint dataType would be used | ||||||
Control | 0..0 | ||||||
Type | Extension(A specific purpose for which this ContactPoint dataType would be used) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
382. Patient.telecom.system | |||||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||
Short | phone | fax | email | pager | url | sms | other | ||||||
Control | 10..1 This element is affected by the following invariants: cpt-2 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | The 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. | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||||
Invariants | ele-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. | ||||||
Short | home | 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. | ||||||
Control | 10..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||
Invariants | ele-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. | ||||||
Short | Specify 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. | ||||||
Control | 0..01 | ||||||
Type | positiveInt | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when the contact point was/is in use | ||||||
Control | 0..01 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | male | 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. | ||||||
Control | 10..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||||
Invariants | ele-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. | ||||||
Short | The 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). | ||||||
Control | 10..1 | ||||||
Type | date | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Age of the individual drives many clinical processes. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
LOINC Code | 21112-8 | ||||||
396. Patient.deceased[x] | |||||||
Definition | Indicates if the individual is deceased or not. | ||||||
Short | deceasedBoolean = 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. | ||||||
Control | 10..1 | ||||||
Type | Choice of: boolean, dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Patient.deceased[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
398. Patient.deceased[x]:deceasedDateTime | |||||||
Slice Name | deceasedDateTime | ||||||
Definition | Indicates if the individual is deceased or not. | ||||||
Short | Indicates 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. | ||||||
Control | 0..1 | ||||||
Type | dateTime, boolean | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
400. Patient.deceased[x]:deceasedBoolean | |||||||
Slice Name | deceasedBoolean | ||||||
Definition | Indicates if the individual is deceased or not. | ||||||
Short | Indicates 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. | ||||||
Control | 0..1 | ||||||
Type | boolean, dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | An 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. | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Address(Common NZ Address datatype) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
406. Patient.address.extension:nz-geocode | |||||||
Slice Name | nz-geocode | ||||||
Definition | New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode. | ||||||
Short | NZ Geocode | ||||||
Control | 0..0 | ||||||
Type | Extension(NZ Geocode) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
408. Patient.address.extension:suburb | |||||||
Slice Name | suburb | ||||||
Definition | Suburb element of a NZ Address. | ||||||
Short | NZ Suburb | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Suburb) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.address.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
412. Patient.address.extension:suburb.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | NZSuburbValue of extension | ||||||
Comments | NZ Suburbs are defined in the NZ Electronic Street Address Mapping (eSAM) standard. | ||||||
Control | 0..1 | ||||||
Type | string, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Label | NZ Suburb | ||||||
Example | <br/><b>Rototuna</b>:Rototuna | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
416. Patient.address.extension:building-name | |||||||
Slice Name | building-name | ||||||
Definition | The name of a building cited in an address. | ||||||
Short | Building Name | ||||||
Control | 0..0 | ||||||
Type | Extension(Building Name) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
418. Patient.address.extension:domicile-code | |||||||
Slice Name | domicile-code | ||||||
Definition | NZ Domicile Code. Derived from a patient's primary physical, home address. | ||||||
Short | NZ Domicile Code | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Domicile Code) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.address.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
424. Patient.address.extension:domicile-code.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This 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: | ||||||
428. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from For codes, see Domicile Code (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code ) | ||||||
Type | CodeableConcept, 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] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 10..1* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | home | 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. | ||||||
Control | 10..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||||||
Example | <br/><b>General</b>:home | ||||||
Invariants | ele-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. | ||||||
Short | PHYSICAL | 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). | ||||||
Control | 10..1 | ||||||
Binding | The 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). | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:both | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 | ||||||
Invariants | ele-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. | ||||||
Short | Street name, number, direction & P.O. Box etc. | ||||||
Control | 0..2* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:137 Nowhere Street | ||||||
Invariants | ele-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. | ||||||
Short | Name of city, town etc. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Municpality | ||||||
Example | <br/><b>General</b>:Erewhon | ||||||
Invariants | ele-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). | ||||||
Short | District 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. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Alternate Names | County | ||||||
Example | <br/><b>General</b>:Madison | ||||||
Invariants | ele-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). | ||||||
Short | Sub-unit of country (abbreviations ok) | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Province, Territory | ||||||
Invariants | ele-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. | ||||||
Short | Postal code for area | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Zip | ||||||
Example | <br/><b>General</b>:9132 | ||||||
Invariants | ele-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. | ||||||
Short | Country (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. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when address was/is in use | ||||||
Control | 0..01 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows addresses to be placed in historical context. | ||||||
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" } | ||||||
Invariants | ele-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. | ||||||
Short | Marital (civil) status of a patient | ||||||
Control | 10..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Most, if not all systems capture it. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.maritalStatus.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
470. Patient.maritalStatus.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 10..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.maritalStatus.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
476. Patient.maritalStatus.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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). | ||||||
Short | Whether 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). | ||||||
Control | 0..01 | ||||||
Type | Choice of: boolean, integer | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
490. Patient.photo | |||||||
Definition | Image of the patient. | ||||||
Short | Image of the patient | ||||||
Comments | Guidelines:
| ||||||
Control | 0..0* | ||||||
Type | Attachment | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Need to track people you can contact about the patient. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
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 Names | extensions, user content, modifiers | ||||||
Invariants | 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()) | ||||||
500. Patient.contact.relationship | |||||||
Definition | The nature of the relationship between the patient and the contact person. | ||||||
Short | The kind of relationship | ||||||
Control | 10..1* | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
504. Patient.contact.relationship.extension:contact-relationship | |||||||
Slice Name | contact-relationship | ||||||
Definition | Coding extension recording the original contact relationship value from NK1-HL7 v2 message that was used to create / update the FHIR resource | ||||||
Short | Contact Relationship | ||||||
Control | 0..1 | ||||||
Type | Extension(Contact Relationship) (Extension Type: Coding) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This 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: | ||||||
508. Patient.contact.relationship.extension:contact-relationship.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This 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: | ||||||
516. Patient.contact.relationship.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | A name associated with the contact person | ||||||
Control | 10..1 | ||||||
Type | HumanName | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.contact.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
534. Patient.contact.name.use | |||||||
Definition | Identifies the purpose for this name. | ||||||
Short | usual | 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. | ||||||
Control | 0..01 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Invariants | ele-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. | ||||||
Short | Family name (often called 'Surname') | ||||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | surname | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
540. Patient.contact.name.given | |||||||
Definition | Given name. | ||||||
Short | Given 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. | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | first name, middle name | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come before the name | ||||||
Control | 0..1* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come after the name | ||||||
Control | 0..0* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..* | ||||||
Type | ContactPoint | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.contact.telecom.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
552. Patient.contact.telecom.system | |||||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||
Short | phone | fax | email | pager | url | sms | other | ||||||
Control | 10..1 This element is affected by the following invariants: cpt-2 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | The 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. | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||||
Invariants | ele-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. | ||||||
Short | home | 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. | ||||||
Control | 10..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||
Invariants | ele-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. | ||||||
Short | Specify 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. | ||||||
Control | 0..01 | ||||||
Type | positiveInt | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Address for the contact person | ||||||
Control | 0..01 | ||||||
Type | Address | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||
Invariants | ele-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. | ||||||
Short | male | female | other | unknown | ||||||
Control | 0..01 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Requirements | Needed to address the person correctly. | ||||||
Invariants | ele-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. | ||||||
Short | Organization that is associated with the contact | ||||||
Control | 0..01 This element is affected by the following invariants: pat-1 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | For guardians or business related contacts, the organization is relevant. | ||||||
Invariants | ele-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. | ||||||
Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
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 Names | extensions, user content, modifiers | ||||||
Invariants | 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()) | ||||||
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. | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.communication.language.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
582. Patient.communication.language.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This 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: | ||||||
588. Patient.communication.language.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 0..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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). | ||||||
Short | Language preference indicator | ||||||
Comments | This language is specifically identified for communicating healthcare information. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | false | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Patient'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. | ||||||
Control | 0..1* | ||||||
Type | Reference(Organization, Practitioner, PractitionerRole) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | false | ||||||
Alternate Names | careProvider | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.generalPractitioner.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
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. | ||||||
Short | Literal 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. | ||||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Type 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. | ||||||
Control | 10..1 | ||||||
Binding | Unless 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). | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Logical 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). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 10..1 | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This element introduces a set of slices on Patient.generalPractitioner.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
616. Patient.generalPractitioner.identifier.use | |||||||
Definition | The purpose of this identifier. | ||||||
Short | usual | official | temp | secondary | old (If known) | ||||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||||
Control | 10..1 | ||||||
Binding | The 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 . | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Description 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. | ||||||
Control | 10..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This 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: | ||||||
624. Patient.generalPractitioner.identifier.type.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
Slicing | This 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: | ||||||
630. Patient.generalPractitioner.identifier.type.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Pattern Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 10..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Pattern Value | LR | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Pattern Value | Local Registry ID | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..01 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | The namespace for the identifier value | ||||||
Comments | Identifier.system is always case sensitive. | ||||||
Control | 10..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 Value | https://standards.digital.health.nz/ns/central-region/pas-practitioner-id | ||||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||||
Invariants | ele-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. | ||||||
Short | The 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. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:123456 | ||||||
Invariants | ele-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. | ||||||
Short | Time period when id is/was valid for use | ||||||
Control | 0..01 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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. | ||||||
Control | 0..01 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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). | ||||||
Control | 0..01 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||||
Invariants | ele-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. | ||||||
Short | Link to another patient resource that concerns the same actual person | ||||||
Comments | There is no assumption that linked patient records have mutual links. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | true 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 Support | true | ||||||
Summary | true | ||||||
Requirements | There are multiple use cases:
| ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | ExtensionAdditional 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. | ||||||
Control | 0..0* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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()) | ||||||
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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
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 Names | extensions, user content, modifiers | ||||||
Invariants | 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()) | ||||||
662. Patient.link.other | |||||||
Definition | The other patient resource that the link refers to. | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Type | Reference(Patient, RelatedPerson) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Literal 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. | ||||||
Control | 0..01 This element is affected by the following invariants: ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | PatientType 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. | ||||||
Control | 0..1 | ||||||
Binding | Unless 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). | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Pattern Value | Patient | ||||||
Invariants | ele-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. | ||||||
Short | Business-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). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 10..1 | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..01 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | replaced-by | replacesreplaced-by | replaces | refer | seealso | ||||||
Control | 1..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Information about an individual or animal receiving health care services | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | SubjectOfCare Client Resident | ||||||
Invariants | dom-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. | ||||||
Short | Logical 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. | ||||||
Control | 0..1 | ||||||
Type | id | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
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. | ||||||
Short | Metadata about the resource | ||||||
Control | 0..1 | ||||||
Type | Meta | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
8. Patient.meta.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 1..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.meta.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
10. Patient.meta.extension:hl7v2Message | |||||||
Slice Name | hl7v2Message | ||||||
Definition | Base64 encoded string containing the original HL7 v2 message that was used to create / update the FHIR resource | ||||||
Short | HL7 v2 Message | ||||||
Control | 1..1 | ||||||
Type | Extension(HL7 v2 Message) (Extension Type: base64Binary) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
14. Patient.meta.extension:hl7v2Message.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.meta.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
16. Patient.meta.extension:hl7v2Message.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | base64Binary | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
20. Patient.meta.extension:process-timestamp | |||||||
Slice Name | process-timestamp | ||||||
Definition | Date and time the source HL7v2 message was translated into FHIR Resource | ||||||
Short | Process TimeStamp | ||||||
Control | 0..1 | ||||||
Type | Extension(Process TimeStamp) (Extension Type: dateTime) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
22. Patient.meta.extension:source-event-trigger | |||||||
Slice Name | source-event-trigger | ||||||
Definition | The HL7v2 message/event trigger that was translated into FHIR Resource (eg A31, I13, etc) | ||||||
Short | Source Event Trigger | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Event Trigger) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
24. Patient.meta.extension:source-record-type | |||||||
Slice Name | source-record-type | ||||||
Definition | The HL7v2 record type that was translated into FHIR Resource (eg ADT, REF, etc) | ||||||
Short | Source Record Type | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Record Type) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
26. Patient.meta.extension:source-record-id | |||||||
Slice Name | source-record-id | ||||||
Definition | The HL7v2 record ID that was translated into FHIR Resource | ||||||
Short | Source Record ID | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Record ID) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
28. Patient.meta.extension:source-data-mode-version | |||||||
Slice Name | source-data-mode-version | ||||||
Definition | The HL7v2 version number for the message/event that was translated into FHIR Resource | ||||||
Short | Source Data Model Version | ||||||
Control | 0..1 | ||||||
Type | Extension(Source Data Model Version) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
30. Patient.meta.extension:process-client-id | |||||||
Slice Name | process-client-id | ||||||
Definition | The HL7v2 Source Client Id for the message/event that was translated into FHIR Resource | ||||||
Short | Process Client ID | ||||||
Control | 0..1 | ||||||
Type | Extension(Process Client ID) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
32. Patient.meta.extension:l4h-template-version | |||||||
Slice Name | l4h-template-version | ||||||
Definition | The version number of the l4h templates used to translate the hl7v2 message into FHIR Resource | ||||||
Short | L4H Template Version | ||||||
Control | 0..1 | ||||||
Type | Extension(L4H Template Version) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Version 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. | ||||||
Control | 0..1 | ||||||
Type | id | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | When 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. | ||||||
Control | 0..1 | ||||||
Type | instant | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Identifies 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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Profiles 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. | ||||||
Control | 0..* | ||||||
Type | canonical(StructureDefinition) | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Security 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. | ||||||
Control | 0..* | ||||||
Binding | Unless 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. | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Tags 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. | ||||||
Control | 0..* | ||||||
Binding | For 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". | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..0 | ||||||
Type | uri | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Language 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). | ||||||
Control | 0..0 | ||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..1 | ||||||
Type | Narrative | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | narrative, html, xhtml, display | ||||||
Invariants | ele-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. | ||||||
Short | Contained, 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. | ||||||
Control | 0..0 | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||
54. Patient.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
56. Patient.extension:ethnicity | |||||||
Slice Name | ethnicity | ||||||
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. | ||||||
Short | NZ Ethnicity | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(NZ Ethnicity) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
60. Patient.extension:ethnicity.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
62. Patient.extension:ethnicity.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 1..1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
66. Patient.extension:ethnicity.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 1..1 | ||||||
Binding | The codes SHOULD be taken from Ethnicity of a person (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
72. Patient.extension:ethnicity.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 0..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
90. Patient.extension:nzCitizen | |||||||
Slice Name | nzCitizen | ||||||
Definition | New Zealand citizenship | ||||||
Short | NZ Citizenship | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(NZ Citizenship) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
94. Patient.extension:nzCitizen.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 1..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
96. Patient.extension:nzCitizen.extension:status | |||||||
Slice Name | status | ||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 1..1 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
100. Patient.extension:nzCitizen.extension:status.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
102. Patient.extension:nzCitizen.extension:status.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | status | ||||||
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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This 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: | ||||||
106. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from NZ Citizenship status (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Is this person a New Zealand citizen? CodeableConcept: yes / no / unknown | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
112. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
130. Patient.extension:nzCitizen.extension:source | |||||||
Slice Name | source | ||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
137. Patient.extension:nzCitizen.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 0..0 | ||||||
Type | Choice 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 Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
141. Patient.extension:dhb | |||||||
Slice Name | dhb | ||||||
Definition | District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). | ||||||
Short | District Health Board linked to a NZ Healthcare Service, Location or Patient | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
145. Patient.extension:dhb.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
147. Patient.extension:dhb.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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. | ||||||
Short | NZ District Health Boards | ||||||
Control | 0..1 | ||||||
Binding | Unless 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 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
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. | ||||||
Label | DHB 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" }] } | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
155. Patient.extension:dhb.value[x].coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
173. Patient.extension:domicile-code | |||||||
Slice Name | domicile-code | ||||||
Definition | NZ Domicile Code. Derived from a patient's primary physical, home address. | ||||||
Short | NZ Domicile Code | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(NZ Domicile Code) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
177. Patient.extension:domicile-code.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
179. Patient.extension:domicile-code.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
183. Patient.extension:domicile-code.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from Domicile Code (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
189. Patient.extension:domicile-code.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
207. Patient.extension:pho | |||||||
Slice Name | pho | ||||||
Definition | Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP). | ||||||
Short | Primary Healthcare Organisation | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Primary Healthcare Organisation) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
209. Patient.extension:sex-at-birth | |||||||
Slice Name | sex-at-birth | ||||||
Definition | A person’s sex at the time of their birth (considered to be immutable). | ||||||
Short | Sex At Birth | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Sex At Birth) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
211. Patient.extension:iwi | |||||||
Slice Name | iwi | ||||||
Definition | Persons Iwi affiliation | ||||||
Short | Extension | ||||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||||
Type | Extension(Nz_iwi) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
213. Patient.extension:nzcrEthnicity | |||||||
Slice Name | nzcrEthnicity | ||||||
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. | ||||||
Short | NZ Ethnicity (Central Region Edition) | ||||||
Control | 0..3 | ||||||
Type | Extension(NZ Ethnicity (Central Region Edition)) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
217. Patient.extension:nzcrEthnicity.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
219. Patient.extension:nzcrEthnicity.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 1..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
227. Patient.extension:nzcrEthnicity.value[x].coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 2..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | level2 | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/ethnic-group-level-2-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | level4 | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/ethnic-group-level-4-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from Ethnicity of a person (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
277. Patient.extension:nzcrResidency | |||||||
Slice Name | nzcrResidency | ||||||
Definition | NZ Residency status, permits multiple codings from different CodeSystems | ||||||
Short | NZ Residency (Central Region Edition) | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Residency (Central Region Edition)) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
283. Patient.extension:nzcrResidency.extension:status | |||||||
Slice Name | status | ||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..1 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
287. Patient.extension:nzcrResidency.extension:status.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
289. Patient.extension:nzcrResidency.extension:status.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | status | ||||||
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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
297. Patient.extension:nzcrResidency.extension:status.value[x].coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 2..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | nzBase | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Pattern Value | https://standards.digital.health.nz/ns/nz-residency-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from NZ Residency status (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | rawSource | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/central-region/nz-residency-code | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
347. Patient.extension:nzcrResidency.extension:source | |||||||
Slice Name | source | ||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
353. Patient.extension:nzcrResidency.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 0..0 | ||||||
Type | Choice 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 Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
357. Patient.extension:nzcrReligion | |||||||
Slice Name | nzcrReligion | ||||||
Definition | Patient religious affiliation extension, permits multiple codings from different CodeSystems | ||||||
Short | Religious Affiliation (Central Region Edition) | ||||||
Control | 0..1 | ||||||
Type | Extension(Religious Affiliation (Central Region Edition)) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
361. Patient.extension:nzcrReligion.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
363. Patient.extension:nzcrReligion.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 1..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
371. Patient.extension:nzcrReligion.value[x].coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | origFhir | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from ReligiousAffiliation (required to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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 Name | rawSource | ||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Fixed Value | https://standards.digital.health.nz/ns/central-region/patient-religion | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Binding | The 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 ) | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
421. Patient.extension:interpreterRequired | |||||||
Slice Name | interpreterRequired | ||||||
Definition | This Patient requires an interpreter to communicate healthcare information to the practitioner. | ||||||
Short | Whether 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. | ||||||
Control | 0..1 | ||||||
Type | Extension(Patient Interpreter Required) (Extension Type: boolean) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | id | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
425. Patient.extension:interpreterRequired.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
427. Patient.extension:interpreterRequired.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 1..1 This element is affected by the following invariants: ext-1 | ||||||
Type | boolean | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Summary | false | ||||||
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 Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
433. Patient.identifier | |||||||
Definition | An identifier for this patient. | ||||||
Short | An identifier for this patient | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..* | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
437. Patient.identifier.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
439. Patient.identifier.use | |||||||
Definition | The purpose of this identifier. | ||||||
Short | usual | official | temp | secondary | old (If known) | ||||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||||
Control | 1..1 | ||||||
Binding | The 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 . | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Description 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. | ||||||
Control | 1..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier.type.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
447. Patient.identifier.type.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
453. Patient.identifier.type.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | The namespace for the identifier value | ||||||
Comments | Identifier.system is always case sensitive. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 | ||||||
Invariants | ele-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. | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:123456 | ||||||
Invariants | ele-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. | ||||||
Short | Time period when id is/was valid for use | ||||||
Control | 0..0 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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. | ||||||
Control | 0..0 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
473. Patient.identifier:NHI | |||||||
Slice Name | NHI | ||||||
Definition | An identifier for this patient. | ||||||
Short | An identifier for this patient | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
477. Patient.identifier:NHI.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
479. Patient.identifier:NHI.use | |||||||
Definition | The purpose of this identifier. | ||||||
Short | usual | official | temp | secondary | old (If known) | ||||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from Valid use values for NHI (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code ) | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Description 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. | ||||||
Control | 1..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||||
Invariants | ele-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. | ||||||
Short | The namespace for the identifier value | ||||||
Comments | Identifier.system is always case sensitive. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 Value | https://standards.digital.health.nz/ns/nhi-id | ||||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||||
Invariants | ele-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. | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:123456 | ||||||
Invariants | ele-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. | ||||||
Short | Time period when id is/was valid for use | ||||||
Control | 0..0 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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. | ||||||
Control | 0..0 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Whether 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 1..* | ||||||
Type | HumanName | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
497. Patient.name.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
499. Patient.name.use | |||||||
Definition | Identifies the purpose for this name. | ||||||
Short | one of: usual / old | ||||||
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1 )The use of a human name. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Invariants | ele-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. | ||||||
Short | Family name (often called 'Surname') | ||||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | surname | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
505. Patient.name.given | |||||||
Definition | Given name. | ||||||
Short | Given 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. | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | first name, middle name | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come before the name | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come after the name | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when name was/is in use | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows names to be placed in historical context. | ||||||
Invariants | ele-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. | ||||||
Short | Details 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). | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | ContactPoint(Common NZ ContactPoint datatype) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||
Invariants | cpt-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
517. Patient.telecom.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.telecom.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
519. Patient.telecom.extension:cp-purpose | |||||||
Slice Name | cp-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. | ||||||
Short | A specific purpose for which this ContactPoint dataType would be used | ||||||
Control | 0..0 | ||||||
Type | Extension(A specific purpose for which this ContactPoint dataType would be used) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
521. Patient.telecom.system | |||||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||
Short | phone | fax | email | pager | url | sms | other | ||||||
Control | 1..1 This element is affected by the following invariants: cpt-2 | ||||||
Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 )Telecommunications form for contact point. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||||
Invariants | ele-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. | ||||||
Short | home | 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. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 )Use of contact point. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||
Invariants | ele-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. | ||||||
Short | Specify 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. | ||||||
Control | 0..0 | ||||||
Type | positiveInt | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when the contact point was/is in use | ||||||
Control | 0..0 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | male | 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. | ||||||
Control | 1..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||||
Invariants | ele-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. | ||||||
Short | The 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). | ||||||
Control | 1..1 | ||||||
Type | date | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Age of the individual drives many clinical processes. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
LOINC Code | 21112-8 | ||||||
535. Patient.deceased[x] | |||||||
Definition | Indicates if the individual is deceased or not. | ||||||
Short | deceasedBoolean = 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. | ||||||
Control | 1..1 | ||||||
Type | Choice of: boolean, dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Patient.deceased[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||||
537. Patient.deceased[x]:deceasedDateTime | |||||||
Slice Name | deceasedDateTime | ||||||
Definition | Indicates if the individual is deceased or not. | ||||||
Short | Indicates 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. | ||||||
Control | 0..1 | ||||||
Type | dateTime | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
539. Patient.deceased[x]:deceasedBoolean | |||||||
Slice Name | deceasedBoolean | ||||||
Definition | Indicates if the individual is deceased or not. | ||||||
Short | Indicates 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | An 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). | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Address(Common NZ Address datatype) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
547. Patient.address.extension:nz-geocode | |||||||
Slice Name | nz-geocode | ||||||
Definition | New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode. | ||||||
Short | NZ Geocode | ||||||
Control | 0..0 | ||||||
Type | Extension(NZ Geocode) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | 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() ) | ||||||
549. Patient.address.extension:suburb | |||||||
Slice Name | suburb | ||||||
Definition | Suburb element of a NZ Address. | ||||||
Short | NZ Suburb | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Suburb) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
553. Patient.address.extension:suburb.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.address.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
555. Patient.address.extension:suburb.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/suburb | ||||||
557. Patient.address.extension:suburb.value[x] | |||||||
Definition | NZ Suburbs | ||||||
Short | NZSuburb | ||||||
Comments | NZ Suburbs are defined in the NZ Electronic Street Address Mapping (eSAM) standard. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Label | NZ Suburb | ||||||
Example | <br/><b>Rototuna</b>:Rototuna | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
559. Patient.address.extension:building-name | |||||||
Slice Name | building-name | ||||||
Definition | The name of a building cited in an address. | ||||||
Short | Building Name | ||||||
Control | 0..0 | ||||||
Type | Extension(Building Name) (Extension Type: string) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
561. Patient.address.extension:domicile-code | |||||||
Slice Name | domicile-code | ||||||
Definition | NZ Domicile Code. Derived from a patient's primary physical, home address. | ||||||
Short | NZ Domicile Code | ||||||
Control | 0..1 | ||||||
Type | Extension(NZ Domicile Code) (Extension Type: CodeableConcept) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
565. Patient.address.extension:domicile-code.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.address.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
567. Patient.address.extension:domicile-code.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | http://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This 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: | ||||||
571. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept | |||||||
Slice Name | valueCodeableConcept | ||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from Domicile Code (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code ) | ||||||
Type | CodeableConcept | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
577. Patient.address.extension:domicile-code.value[x]:valueCodeableConcept.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..1 | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | home | 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. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows an appropriate address to be chosen from a list of many. | ||||||
Example | <br/><b>General</b>:home | ||||||
Invariants | ele-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. | ||||||
Short | PHYSICAL | 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). | ||||||
Control | 1..1 | ||||||
Binding | The 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). | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:both | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 | ||||||
Invariants | ele-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. | ||||||
Short | Street name, number, direction & P.O. Box etc. | ||||||
Control | 0..2 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:137 Nowhere Street | ||||||
Invariants | ele-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. | ||||||
Short | Name of city, town etc. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Municpality | ||||||
Example | <br/><b>General</b>:Erewhon | ||||||
Invariants | ele-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). | ||||||
Short | District 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. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Alternate Names | County | ||||||
Example | <br/><b>General</b>:Madison | ||||||
Invariants | ele-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). | ||||||
Short | Sub-unit of country (abbreviations ok) | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Province, Territory | ||||||
Invariants | ele-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. | ||||||
Short | Postal code for area | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | Zip | ||||||
Example | <br/><b>General</b>:9132 | ||||||
Invariants | ele-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. | ||||||
Short | Country (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. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when address was/is in use | ||||||
Control | 0..0 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows addresses to be placed in historical context. | ||||||
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" } | ||||||
Invariants | ele-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. | ||||||
Short | Marital (civil) status of a patient | ||||||
Control | 1..1 | ||||||
Binding | The 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 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Most, if not all systems capture it. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
619. Patient.maritalStatus.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.maritalStatus.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
621. Patient.maritalStatus.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 1..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
625. Patient.maritalStatus.coding.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.maritalStatus.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
627. Patient.maritalStatus.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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). | ||||||
Short | Whether 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). | ||||||
Control | 0..0 | ||||||
Type | Choice of: boolean, integer | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
641. Patient.photo | |||||||
Definition | Image of the patient. | ||||||
Short | Image of the patient | ||||||
Comments | Guidelines:
| ||||||
Control | 0..0 | ||||||
Type | Attachment | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Need to track people you can contact about the patient. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
647. Patient.contact.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
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 Names | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
651. Patient.contact.relationship | |||||||
Definition | The nature of the relationship between the patient and the contact person. | ||||||
Short | The kind of relationship | ||||||
Control | 1..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.contact.relationship.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
657. Patient.contact.relationship.extension:contact-relationship | |||||||
Slice Name | contact-relationship | ||||||
Definition | Coding extension recording the original contact relationship value from NK1-HL7 v2 message that was used to create / update the FHIR resource | ||||||
Short | Contact Relationship | ||||||
Control | 0..1 | ||||||
Type | Extension(Contact Relationship) (Extension Type: Coding) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
661. Patient.contact.relationship.extension:contact-relationship.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
663. Patient.contact.relationship.extension:contact-relationship.url | |||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
Short | identifies 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
Fixed Value | https://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). | ||||||
Short | Value of extension | ||||||
Control | 0..1 | ||||||
Binding | The 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 ) | ||||||
Type | Coding | ||||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
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. | ||||||
Short | Identity 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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 0..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
685. Patient.contact.relationship.coding.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
687. Patient.contact.relationship.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | A name associated with the contact person | ||||||
Control | 1..1 | ||||||
Type | HumanName | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
703. Patient.contact.name.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.contact.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
705. Patient.contact.name.use | |||||||
Definition | Identifies the purpose for this name. | ||||||
Short | usual | 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. | ||||||
Control | 0..0 | ||||||
Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1 )The use of a human name. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Invariants | ele-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. | ||||||
Short | Family name (often called 'Surname') | ||||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | surname | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
711. Patient.contact.name.given | |||||||
Definition | Given name. | ||||||
Short | Given 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. | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Alternate Names | first name, middle name | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come before the name | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Parts that come after the name | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when name was/is in use | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows names to be placed in historical context. | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..* | ||||||
Type | ContactPoint | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
723. Patient.contact.telecom.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.contact.telecom.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
725. Patient.contact.telecom.system | |||||||
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||||
Short | phone | fax | email | pager | url | sms | other | ||||||
Control | 1..1 This element is affected by the following invariants: cpt-2 | ||||||
Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 )Telecommunications form for contact point. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||||
Invariants | ele-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. | ||||||
Short | home | 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. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 )Use of contact point. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||||
Invariants | ele-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. | ||||||
Short | Specify 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. | ||||||
Control | 0..0 | ||||||
Type | positiveInt | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Time period when the contact point was/is in use | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Address for the contact person | ||||||
Control | 0..0 | ||||||
Type | Address | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||
Invariants | ele-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. | ||||||
Short | male | female | other | unknown | ||||||
Control | 0..0 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Requirements | Needed to address the person correctly. | ||||||
Invariants | ele-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. | ||||||
Short | Organization that is associated with the contact | ||||||
Control | 0..0 This element is affected by the following invariants: pat-1 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | For guardians or business related contacts, the organization is relevant. | ||||||
Invariants | ele-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. | ||||||
Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | ele-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. | ||||||
Short | A 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. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
747. Patient.communication.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
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 Names | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
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. | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
755. Patient.communication.language.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.communication.language.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
757. Patient.communication.language.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
761. Patient.communication.language.coding.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
763. Patient.communication.language.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 0..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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). | ||||||
Short | Language preference indicator | ||||||
Comments | This language is specifically identified for communicating healthcare information. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | false | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Patient'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. | ||||||
Control | 0..1 | ||||||
Type | Reference(Organization, Practitioner, PractitionerRole) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | false | ||||||
Alternate Names | careProvider | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
781. Patient.generalPractitioner.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.generalPractitioner.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
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. | ||||||
Short | Literal 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. | ||||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Type 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. | ||||||
Control | 1..1 | ||||||
Binding | Unless 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). | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Logical 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). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..1 | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
791. Patient.generalPractitioner.identifier.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.generalPractitioner.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
793. Patient.generalPractitioner.identifier.use | |||||||
Definition | The purpose of this identifier. | ||||||
Short | usual | official | temp | secondary | old (If known) | ||||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||||
Control | 1..1 | ||||||
Binding | The 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 . | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||||
Invariants | ele-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. | ||||||
Short | Description 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. | ||||||
Control | 1..1 | ||||||
Binding | Unless 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. | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
799. Patient.generalPractitioner.identifier.type.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
801. Patient.generalPractitioner.identifier.type.coding | |||||||
Definition | A reference to a code defined by a terminology system. | ||||||
Short | Code 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. | ||||||
Control | 0..* | ||||||
Type | Coding | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
805. Patient.generalPractitioner.identifier.type.coding.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
Slicing | This 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: | ||||||
807. Patient.generalPractitioner.identifier.type.coding.system | |||||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||||
Short | Identity 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. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||||
Pattern Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||
Invariants | ele-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. | ||||||
Short | Version 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. | ||||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | Symbol in syntax defined by the system | ||||||
Control | 1..1 | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to refer to a particular code in the system. | ||||||
Pattern Value | LR | ||||||
Invariants | ele-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. | ||||||
Short | Representation defined by the system | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||||
Pattern Value | Local Registry ID | ||||||
Invariants | ele-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). | ||||||
Short | If 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. | ||||||
Control | 0..0 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | Plain text representation of the concept | ||||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
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. | ||||||
Invariants | ele-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. | ||||||
Short | The namespace for the identifier value | ||||||
Comments | Identifier.system is always case sensitive. | ||||||
Control | 1..1 | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
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 Value | https://standards.digital.health.nz/ns/central-region/pas-practitioner-id | ||||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||||
Invariants | ele-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. | ||||||
Short | The 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. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Example | <br/><b>General</b>:123456 | ||||||
Invariants | ele-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. | ||||||
Short | Time period when id is/was valid for use | ||||||
Control | 0..0 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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. | ||||||
Control | 0..0 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Organization 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). | ||||||
Control | 0..0 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||||
Invariants | ele-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. | ||||||
Short | Link to another patient resource that concerns the same actual person | ||||||
Comments | There is no assumption that linked patient records have mutual links. | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | true 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 Support | true | ||||||
Summary | true | ||||||
Requirements | There are multiple use cases:
| ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
835. Patient.link.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..0 | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | 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() ) | ||||||
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). | ||||||
Short | Extensions 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
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 Names | extensions, user content, modifiers | ||||||
Invariants | 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() ) | ||||||
839. Patient.link.other | |||||||
Definition | The other patient resource that the link refers to. | ||||||
Short | The 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. | ||||||
Control | 1..1 | ||||||
Type | Reference(Patient, RelatedPerson) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
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. | ||||||
Short | Additional 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. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | 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() ) | ||||||
Slicing | This element introduces a set of slices on Patient.link.other.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
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. | ||||||
Short | Literal 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. | ||||||
Control | 0..0 This element is affected by the following invariants: ref-1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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). | ||||||
Short | 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. | ||||||
Control | 0..1 | ||||||
Binding | Unless 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). | ||||||
Type | uri | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Pattern Value | Patient | ||||||
Invariants | ele-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. | ||||||
Short | Business-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). | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 1..1 | ||||||
Type | Identifier | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | Text 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. | ||||||
Control | 0..0 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-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. | ||||||
Short | replaced-by | replaces | ||||||
Control | 1..1 | ||||||
Binding | The 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. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |