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

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

Resource Profile: NZCentralRegionAllergyIntolerance - Detailed Descriptions

Active as of 2024-09-17

Definitions for the NZCentralRegionAllergyIntolerance resource profile.

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

0. AllergyIntolerance
2. AllergyIntolerance.meta
4. AllergyIntolerance.meta.extension:process-timestamp
Slice Nameprocess-timestamp
Control0..1
TypeExtension(Process TimeStamp) (Extension Type: dateTime)
Must Supporttrue
6. AllergyIntolerance.meta.extension:source-event-trigger
Slice Namesource-event-trigger
Control0..1
TypeExtension(Source Event Trigger) (Extension Type: CodeableConcept)
Must Supporttrue
8. AllergyIntolerance.meta.extension:source-record-type
Slice Namesource-record-type
Control0..1
TypeExtension(Source Record Type) (Extension Type: CodeableConcept)
Must Supporttrue
10. AllergyIntolerance.meta.extension:source-record-id
Slice Namesource-record-id
Control0..1
TypeExtension(Source Record ID) (Extension Type: string)
Must Supporttrue
12. AllergyIntolerance.meta.extension:source-data-mode-version
Slice Namesource-data-mode-version
Control0..1
TypeExtension(Source Data Model Version) (Extension Type: string)
Must Supporttrue
14. AllergyIntolerance.meta.extension:process-client-id
Slice Nameprocess-client-id
Control0..1
TypeExtension(Process Client ID) (Extension Type: string)
Must Supporttrue
16. AllergyIntolerance.meta.extension:l4h-template-version
Slice Namel4h-template-version
Control0..1
TypeExtension(L4H Template Version) (Extension Type: string)
Must Supporttrue
18. AllergyIntolerance.extension
Control1..?
SlicingThis element introduces a set of slices on AllergyIntolerance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 20. AllergyIntolerance.extension:allergy-alert
    Slice Nameallergy-alert
    Control1..1
    TypeExtension(NZ Central Region Alert) (Complex Extension)
    Must Supporttrue
    22. AllergyIntolerance.extension:allergy-alert.extension
    Control3..?
    24. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory
    Slice NamewebPASCategory
    26. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.url
    28. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]
    BindingThe codes SHALL be taken from NZ Central Region - Allergy Alert Category Value Set
    (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    30. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].system
    32. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].code
    34. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].display
    36. AllergyIntolerance.extension:allergy-alert.extension:severityLevel
    Slice NameseverityLevel
    Definition

    Severity level in range '0'..'9'

    ShortSeverity level in range '0'..'9'
    38. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.url
    40. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    42. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction
    Slice NameallergyReaction
    Definition

    Allergy reaction code from allergy-reaction-code

    ShortAllergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
    Control1..?
    44. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.url
    46. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    48. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding
    50. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.system
    52. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.code
    54. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.display
    56. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate
    Slice NameinactiveDate
    58. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.url
    60. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    62. AllergyIntolerance.extension:allergy-alert.extension:reviewDate
    Slice NamereviewDate
    64. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.url
    66. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    68. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy
    Slice NamelastUpdatedBy
    70. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.url
    72. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    74. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime
    Slice NamelastUpdatedDateTime
    76. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.url
    78. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    80. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital
    Slice NamerecordingHospital
    Control1..?
    82. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.url
    84. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    86. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding
    88. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.system
    90. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.code
    92. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.display
    94. AllergyIntolerance.extension:allergy-alert.extension:comments
    Slice Namecomments
    Control0..0
    96. AllergyIntolerance.extension:allergy-alert.url
    98. AllergyIntolerance.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    Must Supporttrue
    100. AllergyIntolerance.identifier.id
    Control0..0
    102. AllergyIntolerance.identifier.extension
    Control0..0
    104. AllergyIntolerance.identifier.use
    106. AllergyIntolerance.identifier.type
    Control0..0
    108. AllergyIntolerance.identifier.system
    Control1..?
    Must Supporttrue
    Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-alert-id
    110. AllergyIntolerance.identifier.value
    Control1..?
    Must Supporttrue
    112. AllergyIntolerance.identifier.period
    Control0..0
    114. AllergyIntolerance.identifier.assigner
    Control0..0
    116. AllergyIntolerance.clinicalStatus
    Control1..?
    Must Supporttrue
    118. AllergyIntolerance.clinicalStatus.id
    Control0..0
    120. AllergyIntolerance.clinicalStatus.extension
    Control0..0
    122. AllergyIntolerance.clinicalStatus.coding
    Control1..1
    Must Supporttrue
    124. AllergyIntolerance.clinicalStatus.coding.id
    Control0..0
    126. AllergyIntolerance.clinicalStatus.coding.extension
    Control0..0
    128. AllergyIntolerance.clinicalStatus.coding.system
    Control1..?
    Must Supporttrue
    Pattern Valuehttp://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
    130. AllergyIntolerance.clinicalStatus.coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    132. AllergyIntolerance.clinicalStatus.coding.code
    Control1..?
    Must Supporttrue
    134. AllergyIntolerance.clinicalStatus.coding.display
    Control1..?
    Must Supporttrue
    136. AllergyIntolerance.clinicalStatus.coding.userSelected
    Control0..0
    138. AllergyIntolerance.verificationStatus
    Control1..?
    Must Supporttrue
    140. AllergyIntolerance.verificationStatus.id
    Control0..0
    142. AllergyIntolerance.verificationStatus.extension
    Control0..0
    144. AllergyIntolerance.verificationStatus.coding
    Control1..1
    Must Supporttrue
    146. AllergyIntolerance.verificationStatus.coding.id
    Control0..0
    148. AllergyIntolerance.verificationStatus.coding.extension
    Control0..0
    150. AllergyIntolerance.verificationStatus.coding.system
    Control1..?
    Must Supporttrue
    Pattern Valuehttp://terminology.hl7.org/CodeSystem/allergyintolerance-verification
    152. AllergyIntolerance.verificationStatus.coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    154. AllergyIntolerance.verificationStatus.coding.code
    Control1..?
    Must Supporttrue
    156. AllergyIntolerance.verificationStatus.coding.display
    Control1..?
    Must Supporttrue
    158. AllergyIntolerance.verificationStatus.coding.userSelected
    Control0..0
    160. AllergyIntolerance.type
    Control1..?
    Must Supporttrue
    162. AllergyIntolerance.type.id
    Control0..0
    164. AllergyIntolerance.type.extension
    Control0..0
    166. AllergyIntolerance.type.value
    Control0..0
    168. AllergyIntolerance.category
    Control1..1
    Must Supporttrue
    170. AllergyIntolerance.category.id
    Control0..0
    172. AllergyIntolerance.category.extension
    Control0..0
    174. AllergyIntolerance.category.value
    Control0..0
    176. AllergyIntolerance.criticality
    Control1..?
    Must Supporttrue
    178. AllergyIntolerance.criticality.id
    Control0..0
    180. AllergyIntolerance.criticality.extension
    Control0..0
    182. AllergyIntolerance.criticality.value
    Control0..0
    184. AllergyIntolerance.code
    Control1..?
    BindingThe codes SHALL be taken from NZ Central Region - Allergy Alert Code Value Set
    (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code)
    Must Supporttrue
    186. AllergyIntolerance.code.id
    Control0..0
    188. AllergyIntolerance.code.extension
    Control0..0
    190. AllergyIntolerance.code.coding
    Control1..1
    Must Supporttrue
    192. AllergyIntolerance.code.coding.id
    Control0..0
    194. AllergyIntolerance.code.coding.extension
    Control0..0
    196. AllergyIntolerance.code.coding.system
    Control1..?
    Must Supporttrue
    198. AllergyIntolerance.code.coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    200. AllergyIntolerance.code.coding.code
    Control1..?
    Must Supporttrue
    202. AllergyIntolerance.code.coding.display
    Control1..?
    Must Supporttrue
    204. AllergyIntolerance.code.coding.userSelected
    Control0..0
    206. AllergyIntolerance.patient
    Must Supporttrue
    208. AllergyIntolerance.patient.id
    Control0..0
    210. AllergyIntolerance.patient.extension
    Control0..0
    212. AllergyIntolerance.patient.reference
    Must Supporttrue
    214. AllergyIntolerance.patient.type
    Control1..?
    Must Supporttrue
    Pattern ValuePatient
    216. AllergyIntolerance.patient.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    Must Supporttrue
    218. AllergyIntolerance.patient.identifier.id
    Control0..0
    220. AllergyIntolerance.patient.identifier.extension
    Control0..0
    222. AllergyIntolerance.patient.identifier.use
    Control1..?
    Must Supporttrue
    224. AllergyIntolerance.patient.identifier.type
    Control1..?
    Must Supporttrue
    226. AllergyIntolerance.patient.identifier.type.id
    Control0..0
    228. AllergyIntolerance.patient.identifier.type.extension
    Control0..0
    230. AllergyIntolerance.patient.identifier.type.coding
    Must Supporttrue
    232. AllergyIntolerance.patient.identifier.type.coding.id
    Control0..0
    234. AllergyIntolerance.patient.identifier.type.coding.extension
    Control0..0
    236. AllergyIntolerance.patient.identifier.type.coding.system
    Control1..?
    Must Supporttrue
    Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
    238. AllergyIntolerance.patient.identifier.type.coding.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    240. AllergyIntolerance.patient.identifier.type.coding.code
    Control1..?
    Must Supporttrue
    242. AllergyIntolerance.patient.identifier.type.coding.display
    Control1..?
    Must Supporttrue
    244. AllergyIntolerance.patient.identifier.type.coding.userSelected
    Control0..0
    246. AllergyIntolerance.patient.identifier.type.text
    Control0..0
    248. AllergyIntolerance.patient.identifier.system
    Control1..?
    Must Supporttrue
    250. AllergyIntolerance.patient.identifier.value
    Control1..?
    Must Supporttrue
    252. AllergyIntolerance.patient.identifier.period
    Control0..0
    254. AllergyIntolerance.patient.identifier.assigner
    Control0..0
    256. AllergyIntolerance.patient.display
    Must Supporttrue
    258. AllergyIntolerance.encounter
    Control0..0
    260. AllergyIntolerance.onset[x]
    Definition

    Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known

    ShortUse onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known
    TypeChoice of: dateTime, Period, string, Range, Age
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 262. AllergyIntolerance.onset[x]:onsetDateTime
      Slice NameonsetDateTime
      Control0..1
      TypedateTime
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      264. AllergyIntolerance.onset[x]:onsetPeriod
      Slice NameonsetPeriod
      Control0..1
      TypePeriod
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Must Supporttrue
      266. AllergyIntolerance.onset[x]:onsetPeriod.start
      268. AllergyIntolerance.onset[x]:onsetPeriod.end
      270. AllergyIntolerance.recordedDate
      Control0..0
      272. AllergyIntolerance.recorder
      Must Supporttrue
      274. AllergyIntolerance.recorder.id
      Control0..0
      276. AllergyIntolerance.recorder.extension
      Control0..0
      278. AllergyIntolerance.recorder.reference
      Must Supporttrue
      280. AllergyIntolerance.recorder.type
      ShortResource the reference refers to (e.g. 'Practitioner')
      Control1..?
      Must Supporttrue
      Pattern ValuePractitioner
      282. AllergyIntolerance.recorder.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..?
      Must Supporttrue
      284. AllergyIntolerance.recorder.identifier.id
      Control0..0
      286. AllergyIntolerance.recorder.identifier.extension
      Control0..0
      288. AllergyIntolerance.recorder.identifier.use
      Control1..?
      Must Supporttrue
      290. AllergyIntolerance.recorder.identifier.type
      Control1..?
      Must Supporttrue
      292. AllergyIntolerance.recorder.identifier.type.id
      Control0..0
      294. AllergyIntolerance.recorder.identifier.type.extension
      Control0..0
      296. AllergyIntolerance.recorder.identifier.type.coding
      Must Supporttrue
      298. AllergyIntolerance.recorder.identifier.type.coding.id
      Control0..0
      300. AllergyIntolerance.recorder.identifier.type.coding.extension
      Control0..0
      302. AllergyIntolerance.recorder.identifier.type.coding.system
      Control1..?
      Must Supporttrue
      Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
      304. AllergyIntolerance.recorder.identifier.type.coding.version
      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..0
      306. AllergyIntolerance.recorder.identifier.type.coding.code
      Control1..?
      Must Supporttrue
      Pattern ValueLR
      308. AllergyIntolerance.recorder.identifier.type.coding.display
      Control1..?
      Must Supporttrue
      Pattern ValueLocal Registry ID
      310. AllergyIntolerance.recorder.identifier.type.coding.userSelected
      Control0..0
      312. AllergyIntolerance.recorder.identifier.type.text
      Control0..0
      314. AllergyIntolerance.recorder.identifier.system
      Control1..?
      Must Supporttrue
      Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-practitioner-id
      316. AllergyIntolerance.recorder.identifier.value
      318. AllergyIntolerance.recorder.identifier.period
      Control0..0
      320. AllergyIntolerance.recorder.identifier.assigner
      Control0..0
      322. AllergyIntolerance.recorder.display
      Must Supporttrue
      324. AllergyIntolerance.asserter
      Control0..0
      326. AllergyIntolerance.lastOccurrence
      Control0..0
      328. AllergyIntolerance.note
      Control0..1
      Must Supporttrue
      330. AllergyIntolerance.note.author[x]
      Control0..0
      332. AllergyIntolerance.note.time
      Control0..0
      334. AllergyIntolerance.note.text
      Must Supporttrue
      336. AllergyIntolerance.reaction
      Control0..0

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

      0. AllergyIntolerance
      Definition

      Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

      ShortAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
      Comments

      Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

      Control0..*
      Is Modifierfalse
      Summaryfalse
      Alternate NamesAllergy, Intolerance, Adverse Reaction
      Invariantsait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists())
      ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty())
      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())
      ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists())
      ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty())
      2. AllergyIntolerance.meta
      Definition

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

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

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

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

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

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

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

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

      The HL7v2 record ID that was translated into FHIR Resource

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

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

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

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

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

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

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

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

      ShortA set of rules under which this content was created
      Comments

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

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

      An Extension


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

      ShortExtensionAdditional content defined by implementations
      Comments

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

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

        Complex extension recording meta data about all alerts, on who recorded the Flag and AllergyIntolerance flavours of Alert and when.

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

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

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

        An Extension


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

        ShortExtensionAdditional content defined by implementations
        Comments

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

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

          An Extension

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

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

          ShortUnique id for inter-element referencing
          Control0..01
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          32. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.extension
          Definition

          An Extension


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

          ShortExtensionAdditional content defined by implementations
          Comments

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

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

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

            Shortidentifies the meaning of the extension
            Comments

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

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed ValuewebPASCategory
            36. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]
            Definition

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

            ShortValue of extension
            Control10..1
            BindingThe codes SHALL be taken from For codes, see NZ Central Region - Allergy Alert Category Value Set
            (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy)
            TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, 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, boolean, Expression, Signature, unsignedInt, time
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..01
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            40. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].extension
            Definition

            An Extension


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

            ShortExtensionAdditional content defined by implementations
            Comments

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

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

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

              ShortIdentity of the terminology system
              Comments

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

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

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].version
              Definition

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

              ShortVersion of the system - if relevant
              Comments

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

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

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

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

              Need to refer to a particular code in the system.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              48. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].display
              Definition

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

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

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].userSelected
              Definition

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

              ShortIf this coding was chosen directly by the user
              Comments

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

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

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              52. AllergyIntolerance.extension:allergy-alert.extension:severityLevel
              Slice NameseverityLevel
              Definition

              Severity level in range '0'..'9'

              ShortSeverity level in range '0'..'9'Additional content defined by implementations
              Control0..1*
              TypeExtension
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              54. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..01
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              56. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.extension
              Definition

              An Extension


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

              ShortExtensionAdditional content defined by implementations
              Comments

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

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

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

                Shortidentifies the meaning of the extension
                Comments

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

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed ValueseverityLevel
                60. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.value[x]
                Definition

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

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

                Allergy reaction code from allergy-reaction-code

                ShortAllergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)Additional content defined by implementations
                Control10..1*
                TypeExtension
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                64. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.id
                Definition

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

                ShortUnique id for inter-element referencing
                Control0..01
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                66. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.extension
                Definition

                An Extension


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

                ShortExtensionAdditional content defined by implementations
                Comments

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

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

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

                  Shortidentifies the meaning of the extension
                  Comments

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

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed ValueallergyReaction
                  70. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]
                  Definition

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

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

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

                  ShortUnique id for inter-element referencing
                  Control0..01
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  74. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].extension
                  Definition

                  An Extension


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

                  ShortExtensionAdditional content defined by implementations
                  Comments

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

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

                    A reference to a code defined by a terminology system.

                    ShortMultiple codings possible, one is original valuee from WebPAS...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.

                    Control10..*
                    TypeCoding
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.id
                    Definition

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

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

                    An Extension


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

                    ShortExtensionAdditional content defined by implementations
                    Comments

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

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

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

                      ShortIdentity of the terminology system
                      Comments

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

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

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.version
                      Definition

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

                      ShortVersion of the system - if relevant
                      Comments

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

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

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

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

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.display
                      Definition

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

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

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.userSelected
                      Definition

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

                      ShortIf this coding was chosen directly by the user
                      Comments

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

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

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].text
                      Definition

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

                      ShortPlain text representation of the concept
                      Comments

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

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

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate
                      Slice NameinactiveDate
                      Definition

                      An Extension

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

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

                      ShortUnique id for inter-element referencing
                      Control0..01
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      98. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.extension
                      Definition

                      An Extension


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

                      ShortExtensionAdditional content defined by implementations
                      Comments

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

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

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

                        Shortidentifies the meaning of the extension
                        Comments

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

                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed ValueinactiveDate
                        102. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.value[x]
                        Definition

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

                        ShortValue of extension
                        Control10..1
                        Typedate, 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, boolean, Expression, Signature, unsignedInt, time
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        104. AllergyIntolerance.extension:allergy-alert.extension:reviewDate
                        Slice NamereviewDate
                        Definition

                        An Extension

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

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

                        ShortUnique id for inter-element referencing
                        Control0..01
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        108. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.extension
                        Definition

                        An Extension


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

                        ShortExtensionAdditional content defined by implementations
                        Comments

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

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

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

                          Shortidentifies the meaning of the extension
                          Comments

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

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Fixed ValuereviewDate
                          112. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.value[x]
                          Definition

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

                          ShortValue of extension
                          Control10..1
                          Typedate, 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, boolean, Expression, Signature, unsignedInt, time
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          114. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy
                          Slice NamelastUpdatedBy
                          Definition

                          An Extension

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

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

                          ShortUnique id for inter-element referencing
                          Control0..01
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          118. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.extension
                          Definition

                          An Extension


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

                          ShortExtensionAdditional content defined by implementations
                          Comments

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

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

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

                            Shortidentifies the meaning of the extension
                            Comments

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

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed ValuelastUpdatedBy
                            122. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.value[x]
                            Definition

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

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

                            An Extension

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

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

                            ShortUnique id for inter-element referencing
                            Control0..01
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            128. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.extension
                            Definition

                            An Extension


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

                            ShortExtensionAdditional content defined by implementations
                            Comments

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

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

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

                              Shortidentifies the meaning of the extension
                              Comments

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

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              Fixed ValuelastUpdatedDateTime
                              132. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.value[x]
                              Definition

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

                              ShortValue of extension
                              Control10..1
                              TypedateTime, 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, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              134. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital
                              Slice NamerecordingHospital
                              Definition

                              An Extension

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

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

                              ShortUnique id for inter-element referencing
                              Control0..01
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              138. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.extension
                              Definition

                              An Extension


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

                              ShortExtensionAdditional content defined by implementations
                              Comments

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

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

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

                                Shortidentifies the meaning of the extension
                                Comments

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

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                Fixed ValuerecordingHospital
                                142. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]
                                Definition

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

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

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

                                ShortUnique id for inter-element referencing
                                Control0..01
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                146. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].extension
                                Definition

                                An Extension


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

                                ShortExtensionAdditional content defined by implementations
                                Comments

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

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

                                  A reference to a code defined by a terminology system.

                                  ShortMultiple codings possible, one is original value from WebPAS...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.

                                  Control10..*
                                  TypeCoding
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  Requirements

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

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  150. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.id
                                  Definition

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

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

                                  An Extension


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

                                  ShortExtensionAdditional content defined by implementations
                                  Comments

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

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

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

                                    ShortIdentity of the terminology system
                                    Comments

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

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

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    156. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.version
                                    Definition

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

                                    ShortVersion of the system - if relevant
                                    Comments

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

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

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

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

                                    Need to refer to a particular code in the system.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    160. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.display
                                    Definition

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

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

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    162. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.userSelected
                                    Definition

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

                                    ShortIf this coding was chosen directly by the user
                                    Comments

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

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

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    164. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].text
                                    Definition

                                    Describe received code values that are unable to be validated


                                    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.

                                    ShortDescribe received code values that are unable to be validatedPlain text representation of the concept
                                    Comments

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

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

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    166. AllergyIntolerance.extension:allergy-alert.extension:comments
                                    Slice Namecomments
                                    Definition

                                    An Extension

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

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

                                    Shortidentifies the meaning of the extension
                                    Comments

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

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

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

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

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

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

                                    ShortExtensions that cannot be ignored
                                    Comments

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

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

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

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

                                    Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

                                    ShortExternal ids for this item
                                    Comments

                                    This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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

                                    Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

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

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

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

                                    An Extension


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

                                    ShortExtensionAdditional content defined by implementations
                                    Comments

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

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

                                      The purpose of this identifier.

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

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

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

                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                      ShortDescription of identifier
                                      Comments

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

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

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

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

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

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

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

                                      ShortThe namespace for the identifier value
                                      Comments

                                      Identifier.system is always case sensitive.

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

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

                                      Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-alert-id
                                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      190. AllergyIntolerance.identifier.value
                                      Definition

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

                                      ShortThe value that is unique
                                      Comments

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

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

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

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

                                      Organization that issued/manages the identifier.

                                      ShortOrganization that issued id (may be just text)
                                      Comments

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

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

                                      The clinical status of the allergy or intolerance.

                                      Shortactive | inactive | resolved
                                      Comments

                                      Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

                                      Control10..1
                                      This element is affected by the following invariants: ait-1, ait-2
                                      BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
                                      (required to http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1)

                                      The clinical status of the allergy or intolerance.

                                      TypeCodeableConcept
                                      Is Modifiertrue because This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
                                      Must Supporttrue
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      198. AllergyIntolerance.clinicalStatus.id
                                      Definition

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

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

                                      An Extension


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

                                      ShortExtensionAdditional content defined by implementations
                                      Comments

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

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

                                        A reference to a code defined by a terminology system.

                                        ShortCode defined by a terminology system
                                        Comments

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

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

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

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        204. AllergyIntolerance.clinicalStatus.coding.id
                                        Definition

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

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

                                        An Extension


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

                                        ShortExtensionAdditional content defined by implementations
                                        Comments

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

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

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

                                          ShortIdentity of the terminology system
                                          Comments

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

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

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

                                          Pattern Valuehttp://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          210. AllergyIntolerance.clinicalStatus.coding.version
                                          Definition

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

                                          ShortVersion of the system - if relevant
                                          Comments

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

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

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

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

                                          Need to refer to a particular code in the system.

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

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

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

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

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

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

                                          ShortIf this coding was chosen directly by the user
                                          Comments

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

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

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

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          218. AllergyIntolerance.verificationStatus
                                          Definition

                                          Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

                                          Shortunconfirmed | confirmed | refuted | entered-in-error
                                          Comments

                                          The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

                                          Control10..1
                                          This element is affected by the following invariants: ait-1, ait-2
                                          BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
                                          (required to http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1)

                                          Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

                                          TypeCodeableConcept
                                          Is Modifiertrue because This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.
                                          Must Supporttrue
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          220. AllergyIntolerance.verificationStatus.id
                                          Definition

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

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

                                          An Extension


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

                                          ShortExtensionAdditional content defined by implementations
                                          Comments

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

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

                                            A reference to a code defined by a terminology system.

                                            ShortCode defined by a terminology system
                                            Comments

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

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

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

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            226. AllergyIntolerance.verificationStatus.coding.id
                                            Definition

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

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

                                            An Extension


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

                                            ShortExtensionAdditional content defined by implementations
                                            Comments

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

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

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

                                              ShortIdentity of the terminology system
                                              Comments

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

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

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

                                              Pattern Valuehttp://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              232. AllergyIntolerance.verificationStatus.coding.version
                                              Definition

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

                                              ShortVersion of the system - if relevant
                                              Comments

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

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

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

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

                                              Need to refer to a particular code in the system.

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

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

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

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

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

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

                                              ShortIf this coding was chosen directly by the user
                                              Comments

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

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

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

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

                                              Identification of the underlying physiological mechanism for the reaction risk.

                                              Shortallergy | intolerance - Underlying mechanism (if known)
                                              Comments

                                              Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

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

                                              Identification of the underlying physiological mechanism for a Reaction Risk.

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

                                              unique id for the element within a resource (for internal references)


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

                                              Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              244. AllergyIntolerance.type.extension
                                              Definition

                                              An Extension


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

                                              ShortExtensionAdditional content defined by implementations
                                              Comments

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

                                              Control0..0*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              246. AllergyIntolerance.type.value
                                              Definition

                                              Primitive value for code


                                              The actual value

                                              ShortPrimitive value for codePrimitive value for string
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Max Length:1048576
                                              248. AllergyIntolerance.category
                                              Definition

                                              Category of the identified substance.

                                              Shortfood | medication | environment | biologic
                                              Comments

                                              This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

                                              Control10..1*
                                              BindingThe codes SHALL be taken from AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
                                              (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1)

                                              Category of an identified substance associated with allergies or intolerances.

                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summarytrue
                                              Alternate NamesCategory, Type, Reaction Type, Class
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              250. AllergyIntolerance.category.id
                                              Definition

                                              unique id for the element within a resource (for internal references)


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

                                              Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              252. AllergyIntolerance.category.extension
                                              Definition

                                              An Extension


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

                                              ShortExtensionAdditional content defined by implementations
                                              Comments

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

                                              Control0..0*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              254. AllergyIntolerance.category.value
                                              Definition

                                              Primitive value for code


                                              The actual value

                                              ShortPrimitive value for codePrimitive value for string
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Max Length:1048576
                                              256. AllergyIntolerance.criticality
                                              Definition

                                              Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

                                              Shortlow | high | unable-to-assess
                                              Comments

                                              The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

                                              Control10..1
                                              BindingThe codes SHALL be taken from AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
                                              (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1)

                                              Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Summarytrue
                                              Alternate NamesSeverity, Seriousness, Contra-indication, Risk
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              258. AllergyIntolerance.criticality.id
                                              Definition

                                              unique id for the element within a resource (for internal references)


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

                                              Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              260. AllergyIntolerance.criticality.extension
                                              Definition

                                              An Extension


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

                                              ShortExtensionAdditional content defined by implementations
                                              Comments

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

                                              Control0..0*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              262. AllergyIntolerance.criticality.value
                                              Definition

                                              Primitive value for code


                                              The actual value

                                              ShortPrimitive value for codePrimitive value for string
                                              Control0..01
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Max Length:1048576
                                              264. AllergyIntolerance.code
                                              Definition

                                              Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

                                              ShortCode that identifies the allergy or intolerance
                                              Comments

                                              It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

                                              When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

                                              The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

                                              Control10..1
                                              BindingThe codes SHALL be taken from For example codes, see NZ Central Region - Allergy Alert Code Value Sethttp://hl7.org/fhir/ValueSet/allergyintolerance-code
                                              (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Alternate NamesCode
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              266. AllergyIntolerance.code.id
                                              Definition

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

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

                                              An Extension


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

                                              ShortExtensionAdditional content defined by implementations
                                              Comments

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

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

                                                A reference to a code defined by a terminology system.

                                                ShortCode defined by a terminology system
                                                Comments

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

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

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

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

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

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

                                                An Extension


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

                                                ShortExtensionAdditional content defined by implementations
                                                Comments

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

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

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

                                                  ShortIdentity of the terminology system
                                                  Comments

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

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

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

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

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

                                                  ShortVersion of the system - if relevant
                                                  Comments

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

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

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

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

                                                  Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                  ShortIf this coding was chosen directly by the user
                                                  Comments

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

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

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

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  286. AllergyIntolerance.patient
                                                  Definition

                                                  The patient who has the allergy or intolerance.

                                                  ShortWho the sensitivity is for
                                                  Control1..1
                                                  TypeReference(Patient)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Alternate NamesPatient
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  288. AllergyIntolerance.patient.id
                                                  Definition

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

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

                                                  An Extension


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

                                                  ShortExtensionAdditional content defined by implementations
                                                  Comments

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

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

                                                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                    ShortLiteral reference, Relative, internal or absolute URL
                                                    Comments

                                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                    Control0..1
                                                    This element is affected by the following invariants: ref-1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    294. AllergyIntolerance.patient.type
                                                    Definition

                                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                    ShortType the reference refers to (e.g. "Patient")
                                                    Comments

                                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                    Control10..1
                                                    BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                    Aa resource (or, for logical models, the URI of the logical model).

                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Pattern ValuePatient
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    296. AllergyIntolerance.patient.identifier
                                                    Definition

                                                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                    ShortLogical reference, when literal reference is not known
                                                    Comments

                                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                    Control10..1
                                                    TypeIdentifier
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    298. AllergyIntolerance.patient.identifier.id
                                                    Definition

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

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

                                                    An Extension


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

                                                    ShortExtensionAdditional content defined by implementations
                                                    Comments

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

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

                                                      The purpose of this identifier.

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

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

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

                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                                      ShortDescription of identifier
                                                      Comments

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

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

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

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

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

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

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

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

                                                      An Extension


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

                                                      ShortExtensionAdditional content defined by implementations
                                                      Comments

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

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

                                                        A reference to a code defined by a terminology system.

                                                        ShortCode defined by a terminology system
                                                        Comments

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

                                                        Control0..*
                                                        TypeCoding
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Summarytrue
                                                        Requirements

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

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

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

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

                                                        An Extension


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

                                                        ShortExtensionAdditional content defined by implementations
                                                        Comments

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

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

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

                                                          ShortIdentity of the terminology system
                                                          Comments

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

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

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

                                                          Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          318. AllergyIntolerance.patient.identifier.type.coding.version
                                                          Definition

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

                                                          ShortVersion of the system - if relevant
                                                          Comments

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

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

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

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

                                                          Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                          ShortIf this coding was chosen directly by the user
                                                          Comments

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

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

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

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

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

                                                          ShortPlain text representation of the concept
                                                          Comments

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

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

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

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

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

                                                          ShortThe namespace for the identifier value
                                                          Comments

                                                          Identifier.system is always case sensitive.

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

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

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

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

                                                          ShortThe value that is unique
                                                          Comments

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

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

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

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

                                                          Organization that issued/manages the identifier.

                                                          ShortOrganization that issued id (may be just text)
                                                          Comments

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

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

                                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                                          ShortText alternative for the resource
                                                          Comments

                                                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

                                                          The encounter when the allergy or intolerance was asserted.

                                                          ShortEncounter when the allergy or intolerance was asserted
                                                          Control0..01
                                                          TypeReference(Encounter)
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          340. AllergyIntolerance.onset[x]
                                                          Definition

                                                          Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known


                                                          Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                                          ShortUse onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are knownWhen allergy or intolerance was identified
                                                          Control0..1
                                                          TypeChoice of: dateTime, Period, string, Range, Age
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Must Support TypesNo must-support rules about the choice of types/profiles
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                          • type @ $this
                                                          • 342. AllergyIntolerance.onset[x]:onsetDateTime
                                                            Slice NameonsetDateTime
                                                            Definition

                                                            Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                                            ShortWhen allergy or intolerance was identified
                                                            Control0..1
                                                            TypedateTime, string, Period, Range, Age
                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            344. AllergyIntolerance.onset[x]:onsetPeriod
                                                            Slice NameonsetPeriod
                                                            Definition

                                                            Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                                            ShortWhen allergy or intolerance was identified
                                                            Control0..1
                                                            TypePeriod, dateTime, string, Range, Age
                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            346. AllergyIntolerance.onset[x]:onsetPeriod.start
                                                            Definition

                                                            The start of the period. The boundary is inclusive.

                                                            ShortStarting time with inclusive boundary
                                                            Comments

                                                            If the low element is missing, the meaning is that the low boundary is not known.

                                                            Control0..1
                                                            This element is affected by the following invariants: per-1
                                                            TypedateTime
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            348. AllergyIntolerance.onset[x]:onsetPeriod.end
                                                            Definition

                                                            The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                            ShortEnd time with inclusive boundary, if not ongoing
                                                            Comments

                                                            The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                            Control0..1
                                                            This element is affected by the following invariants: per-1
                                                            TypedateTime
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            350. AllergyIntolerance.recordedDate
                                                            Definition

                                                            The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

                                                            ShortDate first version of the resource instance was recorded
                                                            Control0..01
                                                            TypedateTime
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            352. AllergyIntolerance.recorder
                                                            Definition

                                                            Individual who recorded the record and takes responsibility for its content.

                                                            ShortWho recorded the sensitivity
                                                            Control0..1
                                                            TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Must Support TypesNo must-support rules about the choice of types/profiles
                                                            Summaryfalse
                                                            Alternate NamesAuthor
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            354. AllergyIntolerance.recorder.id
                                                            Definition

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

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

                                                            An Extension


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

                                                            ShortExtensionAdditional content defined by implementations
                                                            Comments

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

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

                                                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                              ShortLiteral reference, Relative, internal or absolute URL
                                                              Comments

                                                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                              Control0..1
                                                              This element is affected by the following invariants: ref-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              360. AllergyIntolerance.recorder.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).

                                                              ShortResource the reference refers to (e.g. 'Practitioner')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.

                                                              Control10..1
                                                              BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                              Aa resource (or, for logical models, the URI of the logical model).

                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Pattern ValuePractitioner
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              362. AllergyIntolerance.recorder.identifier
                                                              Definition

                                                              An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                              ShortLogical reference, when literal reference is not known
                                                              Comments

                                                              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                              Control10..1
                                                              TypeIdentifier
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              364. AllergyIntolerance.recorder.identifier.id
                                                              Definition

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

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

                                                              An Extension


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

                                                              ShortExtensionAdditional content defined by implementations
                                                              Comments

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

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

                                                                The purpose of this identifier.

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

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

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

                                                                Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                ShortDescription of identifier
                                                                Comments

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

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

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

                                                                TypeCodeableConcept
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Summarytrue
                                                                Requirements

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

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

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

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

                                                                An Extension


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

                                                                ShortExtensionAdditional content defined by implementations
                                                                Comments

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

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

                                                                  A reference to a code defined by a terminology system.

                                                                  ShortCode defined by a terminology system
                                                                  Comments

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

                                                                  Control0..*
                                                                  TypeCoding
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  Requirements

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

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

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

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

                                                                  An Extension


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

                                                                  ShortExtensionAdditional content defined by implementations
                                                                  Comments

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

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

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

                                                                    ShortIdentity of the terminology system
                                                                    Comments

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

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

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

                                                                    Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    384. AllergyIntolerance.recorder.identifier.type.coding.version
                                                                    Definition

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

                                                                    ShortVersion of the system - if relevant
                                                                    Comments

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

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

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

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

                                                                    Need to refer to a particular code in the system.

                                                                    Pattern ValueLR
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    388. AllergyIntolerance.recorder.identifier.type.coding.display
                                                                    Definition

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

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

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

                                                                    Pattern ValueLocal Registry ID
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    390. AllergyIntolerance.recorder.identifier.type.coding.userSelected
                                                                    Definition

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

                                                                    ShortIf this coding was chosen directly by the user
                                                                    Comments

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

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

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

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

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

                                                                    ShortPlain text representation of the concept
                                                                    Comments

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

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

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

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

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

                                                                    ShortThe namespace for the identifier value
                                                                    Comments

                                                                    Identifier.system is always case sensitive.

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

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

                                                                    Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-practitioner-id
                                                                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    396. AllergyIntolerance.recorder.identifier.value
                                                                    Definition

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

                                                                    ShortThe value that is unique
                                                                    Comments

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

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

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

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

                                                                    Organization that issued/manages the identifier.

                                                                    ShortOrganization that issued id (may be just text)
                                                                    Comments

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

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

                                                                    Plain text narrative that identifies the resource in addition to the resource reference.

                                                                    ShortText alternative for the resource
                                                                    Comments

                                                                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

                                                                    The source of the information about the allergy that is recorded.

                                                                    ShortSource of the information about the allergy
                                                                    Comments

                                                                    The recorder takes responsibility for the content, but can reference the source from where they got it.

                                                                    Control0..01
                                                                    TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole)
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Alternate NamesSource, Informant
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    406. AllergyIntolerance.lastOccurrence
                                                                    Definition

                                                                    Represents the date and/or time of the last known occurrence of a reaction event.

                                                                    ShortDate(/time) of last known occurrence of a reaction
                                                                    Comments

                                                                    This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

                                                                    Control0..01
                                                                    TypedateTime
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    408. AllergyIntolerance.note
                                                                    Definition

                                                                    Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

                                                                    ShortAdditional text not captured in other fields
                                                                    Comments

                                                                    For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

                                                                    Control0..1*
                                                                    TypeAnnotation
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    410. AllergyIntolerance.note.author[x]
                                                                    Definition

                                                                    The individual responsible for making the annotation.

                                                                    ShortIndividual responsible for the annotation
                                                                    Comments

                                                                    Organization is used when there's no need for specific attribution as to who made the comment.

                                                                    Control0..01
                                                                    TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    412. AllergyIntolerance.note.time
                                                                    Definition

                                                                    Indicates when this particular annotation was made.

                                                                    ShortWhen the annotation was made
                                                                    Control0..01
                                                                    TypedateTime
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    414. AllergyIntolerance.note.text
                                                                    Definition

                                                                    The text of the annotation in markdown format.

                                                                    ShortThe annotation - text content (as markdown)
                                                                    Control1..1
                                                                    Typemarkdown
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Must Supporttrue
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    416. AllergyIntolerance.reaction
                                                                    Definition

                                                                    Details about each adverse reaction event linked to exposure to the identified substance.

                                                                    ShortAdverse Reaction Events linked to exposure to substance
                                                                    Control0..0*
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                                                    0. AllergyIntolerance
                                                                    Definition

                                                                    Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

                                                                    ShortAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
                                                                    Comments

                                                                    Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

                                                                    Control0..*
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Alternate NamesAllergy, Intolerance, Adverse Reaction
                                                                    Invariantsait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists())
                                                                    ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error (verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty())
                                                                    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())
                                                                    2. AllergyIntolerance.id
                                                                    Definition

                                                                    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                                                    ShortLogical id of this artifact
                                                                    Comments

                                                                    The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                                                    Control0..1
                                                                    Typeid
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    4. AllergyIntolerance.meta
                                                                    Definition

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

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

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    8. AllergyIntolerance.meta.extension
                                                                    Definition

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

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

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

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

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

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

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

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

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

                                                                      The HL7v2 record ID that was translated into FHIR Resource

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

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

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

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

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

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

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

                                                                      The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                                                                      ShortVersion specific identifier
                                                                      Comments

                                                                      The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                                                                      Control0..1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      26. AllergyIntolerance.meta.lastUpdated
                                                                      Definition

                                                                      When the resource last changed - e.g. when the version changed.

                                                                      ShortWhen the resource version last changed
                                                                      Comments

                                                                      This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                                                                      Control0..1
                                                                      Typeinstant
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      28. AllergyIntolerance.meta.source
                                                                      Definition

                                                                      A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                                                                      ShortIdentifies where the resource comes from
                                                                      Comments

                                                                      In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                                                                      This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                                                                      Control0..1
                                                                      Typeuri
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      30. AllergyIntolerance.meta.profile
                                                                      Definition

                                                                      A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                                                                      ShortProfiles this resource claims to conform to
                                                                      Comments

                                                                      It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                                                                      Control0..*
                                                                      Typecanonical(StructureDefinition)
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      32. AllergyIntolerance.meta.security
                                                                      Definition

                                                                      Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                                                                      ShortSecurity Labels applied to this resource
                                                                      Comments

                                                                      The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                                      Control0..*
                                                                      BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                                                                      (extensible to http://hl7.org/fhir/ValueSet/security-labels)

                                                                      Security Labels from the Healthcare Privacy and Security Classification System.

                                                                      TypeCoding
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      34. AllergyIntolerance.meta.tag
                                                                      Definition

                                                                      Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                                                                      ShortTags applied to this resource
                                                                      Comments

                                                                      The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                                      Control0..*
                                                                      BindingFor example codes, see CommonTags
                                                                      (example to http://hl7.org/fhir/ValueSet/common-tags)

                                                                      Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                                                                      TypeCoding
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      36. AllergyIntolerance.implicitRules
                                                                      Definition

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

                                                                      ShortA set of rules under which this content was created
                                                                      Comments

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

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

                                                                      The base language in which the resource is written.

                                                                      ShortLanguage of the resource content
                                                                      Comments

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

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

                                                                      A human language.

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

                                                                      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                                                      ShortText summary of the resource, for human interpretation
                                                                      Comments

                                                                      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                                                      Control0..1
                                                                      TypeNarrative
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesnarrative, html, xhtml, display
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      42. AllergyIntolerance.contained
                                                                      Definition

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

                                                                      ShortContained, inline Resources
                                                                      Comments

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

                                                                      Control0..*
                                                                      TypeResource
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesinline resources, anonymous resources, contained resources
                                                                      44. AllergyIntolerance.extension
                                                                      Definition

                                                                      An Extension

                                                                      ShortExtension
                                                                      Control1..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on AllergyIntolerance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 46. AllergyIntolerance.extension:allergy-alert
                                                                        Slice Nameallergy-alert
                                                                        Definition

                                                                        Complex extension recording meta data about all alerts, on who recorded the Flag and AllergyIntolerance flavours of Alert and when.

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

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

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..0
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        50. AllergyIntolerance.extension:allergy-alert.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control3..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on AllergyIntolerance.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 52. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory
                                                                          Slice NamewebPASCategory
                                                                          Definition

                                                                          An Extension

                                                                          ShortExtension
                                                                          Control1..1
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          54. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.id
                                                                          Definition

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

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..0
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          56. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.extension
                                                                          Definition

                                                                          An Extension

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

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

                                                                            Shortidentifies the meaning of the extension
                                                                            Comments

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

                                                                            Control1..1
                                                                            Typeuri
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            Fixed ValuewebPASCategory
                                                                            60. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x]
                                                                            Definition

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

                                                                            ShortValue of extension
                                                                            Control1..1
                                                                            BindingThe codes SHALL be taken from NZ Central Region - Allergy Alert Category Value Set
                                                                            (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy)
                                                                            TypeCoding
                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            62. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..0
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            64. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].extension
                                                                            Definition

                                                                            An Extension

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

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

                                                                              ShortIdentity of the terminology system
                                                                              Comments

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

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

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              68. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].version
                                                                              Definition

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

                                                                              ShortVersion of the system - if relevant
                                                                              Comments

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

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

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

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

                                                                              Need to refer to a particular code in the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              72. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].display
                                                                              Definition

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

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

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              74. AllergyIntolerance.extension:allergy-alert.extension:webPASCategory.value[x].userSelected
                                                                              Definition

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

                                                                              ShortIf this coding was chosen directly by the user
                                                                              Comments

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

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

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              76. AllergyIntolerance.extension:allergy-alert.extension:severityLevel
                                                                              Slice NameseverityLevel
                                                                              Definition

                                                                              Severity level in range '0'..'9'

                                                                              ShortSeverity level in range '0'..'9'
                                                                              Control0..1
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              78. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.id
                                                                              Definition

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

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..0
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              80. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.extension
                                                                              Definition

                                                                              An Extension

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

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

                                                                                Shortidentifies the meaning of the extension
                                                                                Comments

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

                                                                                Control1..1
                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                Fixed ValueseverityLevel
                                                                                84. AllergyIntolerance.extension:allergy-alert.extension:severityLevel.value[x]
                                                                                Definition

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

                                                                                ShortValue of extension
                                                                                Control0..1
                                                                                Typestring
                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                86. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction
                                                                                Slice NameallergyReaction
                                                                                Definition

                                                                                Allergy reaction code from allergy-reaction-code

                                                                                ShortAllergy reaction code from [allergy-reaction-code](./ValueSet-nzcr-allergy-reaction-vs.html)
                                                                                Control1..1
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                88. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..0
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                90. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.extension
                                                                                Definition

                                                                                An Extension

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

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

                                                                                  Shortidentifies the meaning of the extension
                                                                                  Comments

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

                                                                                  Control1..1
                                                                                  Typeuri
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  Fixed ValueallergyReaction
                                                                                  94. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x]
                                                                                  Definition

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

                                                                                  ShortValue of extension
                                                                                  Control0..1
                                                                                  BindingThe codes SHALL be taken from NZ Central Region - Allergy Reaction Value Set
                                                                                  (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction)
                                                                                  TypeCodeableConcept
                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  96. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].id
                                                                                  Definition

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

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..0
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  98. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].extension
                                                                                  Definition

                                                                                  An Extension

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

                                                                                    A reference to a code defined by a terminology system.

                                                                                    ShortMultiple codings possible, one is original valuee from WebPAS...
                                                                                    Comments

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

                                                                                    Control1..*
                                                                                    TypeCoding
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Summarytrue
                                                                                    Requirements

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

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

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

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..0
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    104. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.extension
                                                                                    Definition

                                                                                    An Extension

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

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

                                                                                      ShortIdentity of the terminology system
                                                                                      Comments

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

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

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

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      108. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.version
                                                                                      Definition

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

                                                                                      ShortVersion of the system - if relevant
                                                                                      Comments

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

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

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

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

                                                                                      Need to refer to a particular code in the system.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      112. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.display
                                                                                      Definition

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

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

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

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      114. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].coding.userSelected
                                                                                      Definition

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

                                                                                      ShortIf this coding was chosen directly by the user
                                                                                      Comments

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

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

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

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      116. AllergyIntolerance.extension:allergy-alert.extension:allergyReaction.value[x].text
                                                                                      Definition

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

                                                                                      ShortPlain text representation of the concept
                                                                                      Comments

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

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

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

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      118. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate
                                                                                      Slice NameinactiveDate
                                                                                      Definition

                                                                                      An Extension

                                                                                      ShortExtension
                                                                                      Control0..1
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      Summaryfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      120. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.id
                                                                                      Definition

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

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..0
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      122. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.extension
                                                                                      Definition

                                                                                      An Extension

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

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

                                                                                        Shortidentifies the meaning of the extension
                                                                                        Comments

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

                                                                                        Control1..1
                                                                                        Typeuri
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        Fixed ValueinactiveDate
                                                                                        126. AllergyIntolerance.extension:allergy-alert.extension:inactiveDate.value[x]
                                                                                        Definition

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

                                                                                        ShortValue of extension
                                                                                        Control1..1
                                                                                        Typedate
                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        128. AllergyIntolerance.extension:allergy-alert.extension:reviewDate
                                                                                        Slice NamereviewDate
                                                                                        Definition

                                                                                        An Extension

                                                                                        ShortExtension
                                                                                        Control0..1
                                                                                        TypeExtension
                                                                                        Is Modifierfalse
                                                                                        Must Supporttrue
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        130. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.id
                                                                                        Definition

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

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..0
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        132. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.extension
                                                                                        Definition

                                                                                        An Extension

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

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

                                                                                          Shortidentifies the meaning of the extension
                                                                                          Comments

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

                                                                                          Control1..1
                                                                                          Typeuri
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          Fixed ValuereviewDate
                                                                                          136. AllergyIntolerance.extension:allergy-alert.extension:reviewDate.value[x]
                                                                                          Definition

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

                                                                                          ShortValue of extension
                                                                                          Control1..1
                                                                                          Typedate
                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          138. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy
                                                                                          Slice NamelastUpdatedBy
                                                                                          Definition

                                                                                          An Extension

                                                                                          ShortExtension
                                                                                          Control0..1
                                                                                          TypeExtension
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          140. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.id
                                                                                          Definition

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

                                                                                          ShortUnique id for inter-element referencing
                                                                                          Control0..0
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          142. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.extension
                                                                                          Definition

                                                                                          An Extension

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

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

                                                                                            Shortidentifies the meaning of the extension
                                                                                            Comments

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

                                                                                            Control1..1
                                                                                            Typeuri
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            Fixed ValuelastUpdatedBy
                                                                                            146. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedBy.value[x]
                                                                                            Definition

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

                                                                                            ShortValue of extension
                                                                                            Control1..1
                                                                                            Typestring
                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            148. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime
                                                                                            Slice NamelastUpdatedDateTime
                                                                                            Definition

                                                                                            An Extension

                                                                                            ShortExtension
                                                                                            Control0..1
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Must Supporttrue
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            150. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.id
                                                                                            Definition

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

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..0
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            152. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.extension
                                                                                            Definition

                                                                                            An Extension

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

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

                                                                                              Shortidentifies the meaning of the extension
                                                                                              Comments

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

                                                                                              Control1..1
                                                                                              Typeuri
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              Fixed ValuelastUpdatedDateTime
                                                                                              156. AllergyIntolerance.extension:allergy-alert.extension:lastUpdatedDateTime.value[x]
                                                                                              Definition

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

                                                                                              ShortValue of extension
                                                                                              Control1..1
                                                                                              TypedateTime
                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              158. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital
                                                                                              Slice NamerecordingHospital
                                                                                              Definition

                                                                                              An Extension

                                                                                              ShortExtension
                                                                                              Control1..1
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Must Supporttrue
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              160. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.id
                                                                                              Definition

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

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..0
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              162. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.extension
                                                                                              Definition

                                                                                              An Extension

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

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

                                                                                                Shortidentifies the meaning of the extension
                                                                                                Comments

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

                                                                                                Control1..1
                                                                                                Typeuri
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                Fixed ValuerecordingHospital
                                                                                                166. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x]
                                                                                                Definition

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

                                                                                                ShortValue of extension
                                                                                                Control0..1
                                                                                                BindingUnless not suitable, these codes SHALL be taken from NZ Central Region - Hospital Value Set
                                                                                                (extensible to https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code)
                                                                                                TypeCodeableConcept
                                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                Is Modifierfalse
                                                                                                Summaryfalse
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                168. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].id
                                                                                                Definition

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

                                                                                                ShortUnique id for inter-element referencing
                                                                                                Control0..0
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                170. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].extension
                                                                                                Definition

                                                                                                An Extension

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

                                                                                                  A reference to a code defined by a terminology system.

                                                                                                  ShortMultiple codings possible, one is original value from WebPAS...
                                                                                                  Comments

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

                                                                                                  Control1..*
                                                                                                  TypeCoding
                                                                                                  Is Modifierfalse
                                                                                                  Must Supporttrue
                                                                                                  Summarytrue
                                                                                                  Requirements

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

                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  174. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.id
                                                                                                  Definition

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

                                                                                                  ShortUnique id for inter-element referencing
                                                                                                  Control0..0
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                  Summaryfalse
                                                                                                  176. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.extension
                                                                                                  Definition

                                                                                                  An Extension

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

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

                                                                                                    ShortIdentity of the terminology system
                                                                                                    Comments

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

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

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

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    180. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.version
                                                                                                    Definition

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

                                                                                                    ShortVersion of the system - if relevant
                                                                                                    Comments

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

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

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

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

                                                                                                    Need to refer to a particular code in the system.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    184. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.display
                                                                                                    Definition

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

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

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

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    186. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].coding.userSelected
                                                                                                    Definition

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

                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                    Comments

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

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

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

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    188. AllergyIntolerance.extension:allergy-alert.extension:recordingHospital.value[x].text
                                                                                                    Definition

                                                                                                    Describe received code values that are unable to be validated

                                                                                                    ShortDescribe received code values that are unable to be validated
                                                                                                    Comments

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

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

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

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    190. AllergyIntolerance.extension:allergy-alert.extension:comments
                                                                                                    Slice Namecomments
                                                                                                    Definition

                                                                                                    An Extension

                                                                                                    ShortExtension
                                                                                                    Control0..0
                                                                                                    TypeExtension
                                                                                                    Is Modifierfalse
                                                                                                    Must Supporttrue
                                                                                                    Summaryfalse
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                    196. AllergyIntolerance.extension:allergy-alert.url
                                                                                                    Definition

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

                                                                                                    Shortidentifies the meaning of the extension
                                                                                                    Comments

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

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

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

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

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

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

                                                                                                    ShortExtensions that cannot be ignored
                                                                                                    Comments

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

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

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

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

                                                                                                    Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

                                                                                                    ShortExternal ids for this item
                                                                                                    Comments

                                                                                                    This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

                                                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                    Control1..1
                                                                                                    TypeIdentifier
                                                                                                    Is Modifierfalse
                                                                                                    Must Supporttrue
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

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

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

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

                                                                                                    An Extension

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

                                                                                                      The purpose of this identifier.

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

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

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

                                                                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                                                      ShortDescription of identifier
                                                                                                      Comments

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

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

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

                                                                                                      TypeCodeableConcept
                                                                                                      Is Modifierfalse
                                                                                                      Summarytrue
                                                                                                      Requirements

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

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

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

                                                                                                      ShortThe namespace for the identifier value
                                                                                                      Comments

                                                                                                      Identifier.system is always case sensitive.

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

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

                                                                                                      Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-alert-id
                                                                                                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      214. AllergyIntolerance.identifier.value
                                                                                                      Definition

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

                                                                                                      ShortThe value that is unique
                                                                                                      Comments

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

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

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

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

                                                                                                      Organization that issued/manages the identifier.

                                                                                                      ShortOrganization that issued id (may be just text)
                                                                                                      Comments

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

                                                                                                      Control0..0
                                                                                                      TypeReference(Organization)
                                                                                                      Is Modifierfalse
                                                                                                      Summarytrue
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      220. AllergyIntolerance.clinicalStatus
                                                                                                      Definition

                                                                                                      The clinical status of the allergy or intolerance.

                                                                                                      Shortactive | inactive | resolved
                                                                                                      Comments

                                                                                                      Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

                                                                                                      Control1..1
                                                                                                      This element is affected by the following invariants: ait-1, ait-2
                                                                                                      BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes
                                                                                                      (required to http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1)

                                                                                                      The clinical status of the allergy or intolerance.

                                                                                                      TypeCodeableConcept
                                                                                                      Is Modifiertrue because This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
                                                                                                      Must Supporttrue
                                                                                                      Summarytrue
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      222. AllergyIntolerance.clinicalStatus.id
                                                                                                      Definition

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..0
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      224. AllergyIntolerance.clinicalStatus.extension
                                                                                                      Definition

                                                                                                      An Extension

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

                                                                                                        A reference to a code defined by a terminology system.

                                                                                                        ShortCode defined by a terminology system
                                                                                                        Comments

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

                                                                                                        Control1..1
                                                                                                        TypeCoding
                                                                                                        Is Modifierfalse
                                                                                                        Must Supporttrue
                                                                                                        Summarytrue
                                                                                                        Requirements

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

                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        228. AllergyIntolerance.clinicalStatus.coding.id
                                                                                                        Definition

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

                                                                                                        ShortUnique id for inter-element referencing
                                                                                                        Control0..0
                                                                                                        Typestring
                                                                                                        Is Modifierfalse
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        230. AllergyIntolerance.clinicalStatus.coding.extension
                                                                                                        Definition

                                                                                                        An Extension

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

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

                                                                                                          ShortIdentity of the terminology system
                                                                                                          Comments

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

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

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

                                                                                                          Pattern Valuehttp://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          234. AllergyIntolerance.clinicalStatus.coding.version
                                                                                                          Definition

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

                                                                                                          ShortVersion of the system - if relevant
                                                                                                          Comments

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

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

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

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

                                                                                                          Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                                                                          ShortIf this coding was chosen directly by the user
                                                                                                          Comments

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

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

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

                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          242. AllergyIntolerance.clinicalStatus.text
                                                                                                          Definition

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

                                                                                                          ShortPlain text representation of the concept
                                                                                                          Comments

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

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

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

                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          244. AllergyIntolerance.verificationStatus
                                                                                                          Definition

                                                                                                          Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

                                                                                                          Shortunconfirmed | confirmed | refuted | entered-in-error
                                                                                                          Comments

                                                                                                          The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

                                                                                                          Control1..1
                                                                                                          This element is affected by the following invariants: ait-1, ait-2
                                                                                                          BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatusCodes
                                                                                                          (required to http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1)

                                                                                                          Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

                                                                                                          TypeCodeableConcept
                                                                                                          Is Modifiertrue because This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.
                                                                                                          Must Supporttrue
                                                                                                          Summarytrue
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          246. AllergyIntolerance.verificationStatus.id
                                                                                                          Definition

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

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..0
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          248. AllergyIntolerance.verificationStatus.extension
                                                                                                          Definition

                                                                                                          An Extension

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

                                                                                                            A reference to a code defined by a terminology system.

                                                                                                            ShortCode defined by a terminology system
                                                                                                            Comments

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

                                                                                                            Control1..1
                                                                                                            TypeCoding
                                                                                                            Is Modifierfalse
                                                                                                            Must Supporttrue
                                                                                                            Summarytrue
                                                                                                            Requirements

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

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            252. AllergyIntolerance.verificationStatus.coding.id
                                                                                                            Definition

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

                                                                                                            ShortUnique id for inter-element referencing
                                                                                                            Control0..0
                                                                                                            Typestring
                                                                                                            Is Modifierfalse
                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                            Summaryfalse
                                                                                                            254. AllergyIntolerance.verificationStatus.coding.extension
                                                                                                            Definition

                                                                                                            An Extension

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

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

                                                                                                              ShortIdentity of the terminology system
                                                                                                              Comments

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

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

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

                                                                                                              Pattern Valuehttp://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              258. AllergyIntolerance.verificationStatus.coding.version
                                                                                                              Definition

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

                                                                                                              ShortVersion of the system - if relevant
                                                                                                              Comments

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

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

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

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

                                                                                                              Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                                                                              ShortIf this coding was chosen directly by the user
                                                                                                              Comments

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

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

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

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              266. AllergyIntolerance.verificationStatus.text
                                                                                                              Definition

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

                                                                                                              ShortPlain text representation of the concept
                                                                                                              Comments

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

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

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

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

                                                                                                              Identification of the underlying physiological mechanism for the reaction risk.

                                                                                                              Shortallergy | intolerance - Underlying mechanism (if known)
                                                                                                              Comments

                                                                                                              Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

                                                                                                              Control1..1
                                                                                                              BindingThe codes SHALL be taken from AllergyIntoleranceType
                                                                                                              (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1)

                                                                                                              Identification of the underlying physiological mechanism for a Reaction Risk.

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

                                                                                                              unique id for the element within a resource (for internal references)

                                                                                                              Shortxml:id (or equivalent in JSON)
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              272. AllergyIntolerance.type.extension
                                                                                                              Definition

                                                                                                              An Extension

                                                                                                              ShortExtension
                                                                                                              Control0..0
                                                                                                              TypeExtension
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              274. AllergyIntolerance.type.value
                                                                                                              Definition

                                                                                                              Primitive value for code

                                                                                                              ShortPrimitive value for code
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              276. AllergyIntolerance.category
                                                                                                              Definition

                                                                                                              Category of the identified substance.

                                                                                                              Shortfood | medication | environment | biologic
                                                                                                              Comments

                                                                                                              This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

                                                                                                              Control1..1
                                                                                                              BindingThe codes SHALL be taken from AllergyIntoleranceCategory
                                                                                                              (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1)

                                                                                                              Category of an identified substance associated with allergies or intolerances.

                                                                                                              Typecode
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Alternate NamesCategory, Type, Reaction Type, Class
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              278. AllergyIntolerance.category.id
                                                                                                              Definition

                                                                                                              unique id for the element within a resource (for internal references)

                                                                                                              Shortxml:id (or equivalent in JSON)
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              280. AllergyIntolerance.category.extension
                                                                                                              Definition

                                                                                                              An Extension

                                                                                                              ShortExtension
                                                                                                              Control0..0
                                                                                                              TypeExtension
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              282. AllergyIntolerance.category.value
                                                                                                              Definition

                                                                                                              Primitive value for code

                                                                                                              ShortPrimitive value for code
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              284. AllergyIntolerance.criticality
                                                                                                              Definition

                                                                                                              Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

                                                                                                              Shortlow | high | unable-to-assess
                                                                                                              Comments

                                                                                                              The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

                                                                                                              Control1..1
                                                                                                              BindingThe codes SHALL be taken from AllergyIntoleranceCriticality
                                                                                                              (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1)

                                                                                                              Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

                                                                                                              Typecode
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Alternate NamesSeverity, Seriousness, Contra-indication, Risk
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              286. AllergyIntolerance.criticality.id
                                                                                                              Definition

                                                                                                              unique id for the element within a resource (for internal references)

                                                                                                              Shortxml:id (or equivalent in JSON)
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              288. AllergyIntolerance.criticality.extension
                                                                                                              Definition

                                                                                                              An Extension

                                                                                                              ShortExtension
                                                                                                              Control0..0
                                                                                                              TypeExtension
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              290. AllergyIntolerance.criticality.value
                                                                                                              Definition

                                                                                                              Primitive value for code

                                                                                                              ShortPrimitive value for code
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              292. AllergyIntolerance.code
                                                                                                              Definition

                                                                                                              Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

                                                                                                              ShortCode that identifies the allergy or intolerance
                                                                                                              Comments

                                                                                                              It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

                                                                                                              When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

                                                                                                              The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

                                                                                                              Control1..1
                                                                                                              BindingThe codes SHALL be taken from NZ Central Region - Allergy Alert Code Value Set
                                                                                                              (required to https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code)
                                                                                                              TypeCodeableConcept
                                                                                                              Is Modifierfalse
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Alternate NamesCode
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              294. AllergyIntolerance.code.id
                                                                                                              Definition

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

                                                                                                              ShortUnique id for inter-element referencing
                                                                                                              Control0..0
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              296. AllergyIntolerance.code.extension
                                                                                                              Definition

                                                                                                              An Extension

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

                                                                                                                A reference to a code defined by a terminology system.

                                                                                                                ShortCode defined by a terminology system
                                                                                                                Comments

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

                                                                                                                Control1..1
                                                                                                                TypeCoding
                                                                                                                Is Modifierfalse
                                                                                                                Must Supporttrue
                                                                                                                Summarytrue
                                                                                                                Requirements

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

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

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

                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                Control0..0
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                Summaryfalse
                                                                                                                302. AllergyIntolerance.code.coding.extension
                                                                                                                Definition

                                                                                                                An Extension

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

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

                                                                                                                  ShortIdentity of the terminology system
                                                                                                                  Comments

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

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

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

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

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

                                                                                                                  ShortVersion of the system - if relevant
                                                                                                                  Comments

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

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

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

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

                                                                                                                  Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                                                                                  ShortIf this coding was chosen directly by the user
                                                                                                                  Comments

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

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

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

                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  314. AllergyIntolerance.code.text
                                                                                                                  Definition

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

                                                                                                                  ShortPlain text representation of the concept
                                                                                                                  Comments

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

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

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

                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  316. AllergyIntolerance.patient
                                                                                                                  Definition

                                                                                                                  The patient who has the allergy or intolerance.

                                                                                                                  ShortWho the sensitivity is for
                                                                                                                  Control1..1
                                                                                                                  TypeReference(Patient)
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  Summarytrue
                                                                                                                  Alternate NamesPatient
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  318. AllergyIntolerance.patient.id
                                                                                                                  Definition

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

                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                  Control0..0
                                                                                                                  Typestring
                                                                                                                  Is Modifierfalse
                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                  Summaryfalse
                                                                                                                  320. AllergyIntolerance.patient.extension
                                                                                                                  Definition

                                                                                                                  An Extension

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

                                                                                                                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                                                                    ShortLiteral reference, Relative, internal or absolute URL
                                                                                                                    Comments

                                                                                                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                                                                    Control0..1
                                                                                                                    This element is affected by the following invariants: ref-1
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    324. AllergyIntolerance.patient.type
                                                                                                                    Definition

                                                                                                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                                                    ShortType the reference refers to (e.g. "Patient")
                                                                                                                    Comments

                                                                                                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                                                    Control1..1
                                                                                                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                                                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                                                                                    Aa resource (or, for logical models, the URI of the logical model).

                                                                                                                    Typeuri
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Pattern ValuePatient
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    326. AllergyIntolerance.patient.identifier
                                                                                                                    Definition

                                                                                                                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                                                                    ShortLogical reference, when literal reference is not known
                                                                                                                    Comments

                                                                                                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                                                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                                                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                    Control1..1
                                                                                                                    TypeIdentifier
                                                                                                                    Is Modifierfalse
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    328. AllergyIntolerance.patient.identifier.id
                                                                                                                    Definition

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

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

                                                                                                                    An Extension

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

                                                                                                                      The purpose of this identifier.

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

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

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

                                                                                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                                                                      ShortDescription of identifier
                                                                                                                      Comments

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

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

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

                                                                                                                      TypeCodeableConcept
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supporttrue
                                                                                                                      Summarytrue
                                                                                                                      Requirements

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

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

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

                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                      Control0..0
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                      Summaryfalse
                                                                                                                      338. AllergyIntolerance.patient.identifier.type.extension
                                                                                                                      Definition

                                                                                                                      An Extension

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

                                                                                                                        A reference to a code defined by a terminology system.

                                                                                                                        ShortCode defined by a terminology system
                                                                                                                        Comments

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

                                                                                                                        Control0..*
                                                                                                                        TypeCoding
                                                                                                                        Is Modifierfalse
                                                                                                                        Must Supporttrue
                                                                                                                        Summarytrue
                                                                                                                        Requirements

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

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

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

                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                        Control0..0
                                                                                                                        Typestring
                                                                                                                        Is Modifierfalse
                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                        Summaryfalse
                                                                                                                        344. AllergyIntolerance.patient.identifier.type.coding.extension
                                                                                                                        Definition

                                                                                                                        An Extension

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

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

                                                                                                                          ShortIdentity of the terminology system
                                                                                                                          Comments

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

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

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

                                                                                                                          Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          348. AllergyIntolerance.patient.identifier.type.coding.version
                                                                                                                          Definition

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

                                                                                                                          ShortVersion of the system - if relevant
                                                                                                                          Comments

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

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

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

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

                                                                                                                          Need to refer to a particular code in the system.

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

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

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

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

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

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

                                                                                                                          ShortIf this coding was chosen directly by the user
                                                                                                                          Comments

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

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

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

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

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

                                                                                                                          ShortPlain text representation of the concept
                                                                                                                          Comments

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

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

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

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

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

                                                                                                                          ShortThe namespace for the identifier value
                                                                                                                          Comments

                                                                                                                          Identifier.system is always case sensitive.

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

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

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

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

                                                                                                                          ShortThe value that is unique
                                                                                                                          Comments

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

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

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

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

                                                                                                                          Organization that issued/manages the identifier.

                                                                                                                          ShortOrganization that issued id (may be just text)
                                                                                                                          Comments

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

                                                                                                                          Control0..0
                                                                                                                          TypeReference(Organization)
                                                                                                                          Is Modifierfalse
                                                                                                                          Summarytrue
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          366. AllergyIntolerance.patient.display
                                                                                                                          Definition

                                                                                                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                                                          ShortText alternative for the resource
                                                                                                                          Comments

                                                                                                                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

                                                                                                                          The encounter when the allergy or intolerance was asserted.

                                                                                                                          ShortEncounter when the allergy or intolerance was asserted
                                                                                                                          Control0..0
                                                                                                                          TypeReference(Encounter)
                                                                                                                          Is Modifierfalse
                                                                                                                          Summaryfalse
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          370. AllergyIntolerance.onset[x]
                                                                                                                          Definition

                                                                                                                          Use onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known

                                                                                                                          ShortUse onsetDateTime when only start time is known; otherwise use onsetPeriod when both start and end time are known
                                                                                                                          Control0..1
                                                                                                                          TypeChoice of: dateTime, Period
                                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                          Is Modifierfalse
                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                          Must Supporttrue
                                                                                                                          Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                          Summaryfalse
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                                                          • type @ $this
                                                                                                                          • 372. AllergyIntolerance.onset[x]:onsetDateTime
                                                                                                                            Slice NameonsetDateTime
                                                                                                                            Definition

                                                                                                                            Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                                                                                                            ShortWhen allergy or intolerance was identified
                                                                                                                            Control0..1
                                                                                                                            TypedateTime
                                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            Summaryfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            374. AllergyIntolerance.onset[x]:onsetPeriod
                                                                                                                            Slice NameonsetPeriod
                                                                                                                            Definition

                                                                                                                            Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                                                                                                            ShortWhen allergy or intolerance was identified
                                                                                                                            Control0..1
                                                                                                                            TypePeriod
                                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                            Is Modifierfalse
                                                                                                                            Must Supporttrue
                                                                                                                            Summaryfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            376. AllergyIntolerance.onset[x]:onsetPeriod.id
                                                                                                                            Definition

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

                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                            Control0..1
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                            Summaryfalse
                                                                                                                            378. AllergyIntolerance.onset[x]:onsetPeriod.extension
                                                                                                                            Definition

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

                                                                                                                            ShortAdditional content defined by implementations
                                                                                                                            Comments

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

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

                                                                                                                              The start of the period. The boundary is inclusive.

                                                                                                                              ShortStarting time with inclusive boundary
                                                                                                                              Comments

                                                                                                                              If the low element is missing, the meaning is that the low boundary is not known.

                                                                                                                              Control0..1
                                                                                                                              This element is affected by the following invariants: per-1
                                                                                                                              TypedateTime
                                                                                                                              Is Modifierfalse
                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                              Summarytrue
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              382. AllergyIntolerance.onset[x]:onsetPeriod.end
                                                                                                                              Definition

                                                                                                                              The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                                                                                              ShortEnd time with inclusive boundary, if not ongoing
                                                                                                                              Comments

                                                                                                                              The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                                                                                              Control0..1
                                                                                                                              This element is affected by the following invariants: per-1
                                                                                                                              TypedateTime
                                                                                                                              Is Modifierfalse
                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                              Summarytrue
                                                                                                                              Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              384. AllergyIntolerance.recordedDate
                                                                                                                              Definition

                                                                                                                              The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

                                                                                                                              ShortDate first version of the resource instance was recorded
                                                                                                                              Control0..0
                                                                                                                              TypedateTime
                                                                                                                              Is Modifierfalse
                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                              Summaryfalse
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              386. AllergyIntolerance.recorder
                                                                                                                              Definition

                                                                                                                              Individual who recorded the record and takes responsibility for its content.

                                                                                                                              ShortWho recorded the sensitivity
                                                                                                                              Control0..1
                                                                                                                              TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson)
                                                                                                                              Is Modifierfalse
                                                                                                                              Must Supporttrue
                                                                                                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                              Summaryfalse
                                                                                                                              Alternate NamesAuthor
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              388. AllergyIntolerance.recorder.id
                                                                                                                              Definition

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

                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                              Control0..0
                                                                                                                              Typestring
                                                                                                                              Is Modifierfalse
                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                              Summaryfalse
                                                                                                                              390. AllergyIntolerance.recorder.extension
                                                                                                                              Definition

                                                                                                                              An Extension

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

                                                                                                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                                                                                ShortLiteral reference, Relative, internal or absolute URL
                                                                                                                                Comments

                                                                                                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                                                                                Control0..1
                                                                                                                                This element is affected by the following invariants: ref-1
                                                                                                                                Typestring
                                                                                                                                Is Modifierfalse
                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                394. AllergyIntolerance.recorder.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).

                                                                                                                                ShortResource the reference refers to (e.g. 'Practitioner')
                                                                                                                                Comments

                                                                                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                                                                Control1..1
                                                                                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                                                                                                Aa resource (or, for logical models, the URI of the logical model).

                                                                                                                                Typeuri
                                                                                                                                Is Modifierfalse
                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Pattern ValuePractitioner
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                396. AllergyIntolerance.recorder.identifier
                                                                                                                                Definition

                                                                                                                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                                                                                                ShortLogical reference, when literal reference is not known
                                                                                                                                Comments

                                                                                                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                                                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                                                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                Control1..1
                                                                                                                                TypeIdentifier
                                                                                                                                Is Modifierfalse
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                398. AllergyIntolerance.recorder.identifier.id
                                                                                                                                Definition

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

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

                                                                                                                                An Extension

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

                                                                                                                                  The purpose of this identifier.

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

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

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

                                                                                                                                  Identifies the purpose for this identifier, if known .

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

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

                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                  404. AllergyIntolerance.recorder.identifier.type
                                                                                                                                  Definition

                                                                                                                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                  ShortDescription of identifier
                                                                                                                                  Comments

                                                                                                                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                  Control1..1
                                                                                                                                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                                                                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                                                                                                                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                  TypeCodeableConcept
                                                                                                                                  Is Modifierfalse
                                                                                                                                  Must Supporttrue
                                                                                                                                  Summarytrue
                                                                                                                                  Requirements

                                                                                                                                  Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                  406. AllergyIntolerance.recorder.identifier.type.id
                                                                                                                                  Definition

                                                                                                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                  Control0..0
                                                                                                                                  Typestring
                                                                                                                                  Is Modifierfalse
                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                  Summaryfalse
                                                                                                                                  408. AllergyIntolerance.recorder.identifier.type.extension
                                                                                                                                  Definition

                                                                                                                                  An Extension

                                                                                                                                  ShortExtension
                                                                                                                                  Control0..0
                                                                                                                                  TypeExtension
                                                                                                                                  Is Modifierfalse
                                                                                                                                  Summaryfalse
                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                  SlicingThis element introduces a set of slices on AllergyIntolerance.recorder.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                  • value @ url
                                                                                                                                  • 410. AllergyIntolerance.recorder.identifier.type.coding
                                                                                                                                    Definition

                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                    Comments

                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                    Control0..*
                                                                                                                                    TypeCoding
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    412. AllergyIntolerance.recorder.identifier.type.coding.id
                                                                                                                                    Definition

                                                                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                    Control0..0
                                                                                                                                    Typestring
                                                                                                                                    Is Modifierfalse
                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                    Summaryfalse
                                                                                                                                    414. AllergyIntolerance.recorder.identifier.type.coding.extension
                                                                                                                                    Definition

                                                                                                                                    An Extension

                                                                                                                                    ShortExtension
                                                                                                                                    Control0..0
                                                                                                                                    TypeExtension
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Summaryfalse
                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                    SlicingThis element introduces a set of slices on AllergyIntolerance.recorder.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                    • value @ url
                                                                                                                                    • 416. AllergyIntolerance.recorder.identifier.type.coding.system
                                                                                                                                      Definition

                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                      Comments

                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                      Control1..1
                                                                                                                                      Typeuri
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                      Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      418. AllergyIntolerance.recorder.identifier.type.coding.version
                                                                                                                                      Definition

                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                      Comments

                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                      Control0..0
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      420. AllergyIntolerance.recorder.identifier.type.coding.code
                                                                                                                                      Definition

                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                      Control1..1
                                                                                                                                      Typecode
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                      Pattern ValueLR
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      422. AllergyIntolerance.recorder.identifier.type.coding.display
                                                                                                                                      Definition

                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                      Control1..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                      Pattern ValueLocal Registry ID
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      424. AllergyIntolerance.recorder.identifier.type.coding.userSelected
                                                                                                                                      Definition

                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                      Comments

                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                      Control0..0
                                                                                                                                      Typeboolean
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      426. AllergyIntolerance.recorder.identifier.type.text
                                                                                                                                      Definition

                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                      Comments

                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                                                                      Control0..0
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      428. AllergyIntolerance.recorder.identifier.system
                                                                                                                                      Definition

                                                                                                                                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                      ShortThe namespace for the identifier value
                                                                                                                                      Comments

                                                                                                                                      Identifier.system is always case sensitive.

                                                                                                                                      Control1..1
                                                                                                                                      Typeuri
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                      Pattern Valuehttps://standards.digital.health.nz/ns/central-region/pas-practitioner-id
                                                                                                                                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      430. AllergyIntolerance.recorder.identifier.value
                                                                                                                                      Definition

                                                                                                                                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                      ShortThe value that is unique
                                                                                                                                      Comments

                                                                                                                                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Example<br/><b>General</b>:123456
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      432. AllergyIntolerance.recorder.identifier.period
                                                                                                                                      Definition

                                                                                                                                      Time period during which identifier is/was valid for use.

                                                                                                                                      ShortTime period when id is/was valid for use
                                                                                                                                      Control0..0
                                                                                                                                      TypePeriod
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Summarytrue
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      434. AllergyIntolerance.recorder.identifier.assigner
                                                                                                                                      Definition

                                                                                                                                      Organization that issued/manages the identifier.

                                                                                                                                      ShortOrganization that issued id (may be just text)
                                                                                                                                      Comments

                                                                                                                                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                      Control0..0
                                                                                                                                      TypeReference(Organization)
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Summarytrue
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      436. AllergyIntolerance.recorder.display
                                                                                                                                      Definition

                                                                                                                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                                                                      ShortText alternative for the resource
                                                                                                                                      Comments

                                                                                                                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      438. AllergyIntolerance.asserter
                                                                                                                                      Definition

                                                                                                                                      The source of the information about the allergy that is recorded.

                                                                                                                                      ShortSource of the information about the allergy
                                                                                                                                      Comments

                                                                                                                                      The recorder takes responsibility for the content, but can reference the source from where they got it.

                                                                                                                                      Control0..0
                                                                                                                                      TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole)
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Summarytrue
                                                                                                                                      Alternate NamesSource, Informant
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      440. AllergyIntolerance.lastOccurrence
                                                                                                                                      Definition

                                                                                                                                      Represents the date and/or time of the last known occurrence of a reaction event.

                                                                                                                                      ShortDate(/time) of last known occurrence of a reaction
                                                                                                                                      Comments

                                                                                                                                      This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

                                                                                                                                      Control0..0
                                                                                                                                      TypedateTime
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summaryfalse
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      442. AllergyIntolerance.note
                                                                                                                                      Definition

                                                                                                                                      Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

                                                                                                                                      ShortAdditional text not captured in other fields
                                                                                                                                      Comments

                                                                                                                                      For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

                                                                                                                                      Control0..1
                                                                                                                                      TypeAnnotation
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summaryfalse
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      444. AllergyIntolerance.note.id
                                                                                                                                      Definition

                                                                                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                      Summaryfalse
                                                                                                                                      446. AllergyIntolerance.note.extension
                                                                                                                                      Definition

                                                                                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                                      Comments

                                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                      Control0..*
                                                                                                                                      TypeExtension
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Summaryfalse
                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                      SlicingThis element introduces a set of slices on AllergyIntolerance.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                      • value @ url
                                                                                                                                      • 448. AllergyIntolerance.note.author[x]
                                                                                                                                        Definition

                                                                                                                                        The individual responsible for making the annotation.

                                                                                                                                        ShortIndividual responsible for the annotation
                                                                                                                                        Comments

                                                                                                                                        Organization is used when there's no need for specific attribution as to who made the comment.

                                                                                                                                        Control0..0
                                                                                                                                        TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Summarytrue
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        450. AllergyIntolerance.note.time
                                                                                                                                        Definition

                                                                                                                                        Indicates when this particular annotation was made.

                                                                                                                                        ShortWhen the annotation was made
                                                                                                                                        Control0..0
                                                                                                                                        TypedateTime
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Summarytrue
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        452. AllergyIntolerance.note.text
                                                                                                                                        Definition

                                                                                                                                        The text of the annotation in markdown format.

                                                                                                                                        ShortThe annotation - text content (as markdown)
                                                                                                                                        Control1..1
                                                                                                                                        Typemarkdown
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summarytrue
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        454. AllergyIntolerance.reaction
                                                                                                                                        Definition

                                                                                                                                        Details about each adverse reaction event linked to exposure to the identified substance.

                                                                                                                                        ShortAdverse Reaction Events linked to exposure to substance
                                                                                                                                        Control0..0
                                                                                                                                        TypeBackboneElement
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Summaryfalse
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))