STU 2 Ballot
This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions 
This profile sets minimum expectations for the AllergyIntolerance resource to record, search and fetch allergies/adverse events associated with a patient. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the AllergyIntolerance resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the DAF-Core AllergyIntolerance profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each AllergyIntolerance must have:
Profile specific implementation guidance:
The following are example usage scenarios for the DAF-AllergyIntolerance profile:
The official URL for this profile is:
http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-allergyintolerance
This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR - Infrastructure).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from AllergyIntolerance
AllergyIntolerance.status which has an required binding to:
AllergyIntolerance.code which has an extensible binding to:
AllergyIntolerance.patientThis structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | I | 0..* | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
  id | ∑ | 0..1 | id | Logical id of this artifact |
 meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ∑ | 0..* | Identifier | External ids for this item |
| status | ?!S | 1..1 | code | active | active-confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required) |
| type | ∑ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | ∑ | 0..1 | code | food | medication | biologic | environment Binding: AllergyIntoleranceCategory (required) |
| criticality | ∑ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | S | 1..1 | CodeableConcept | Allergy or intolerance code Binding: DAF Substance-Reactant for Intolerance and Negation Codes (extensible) |
 patient | S | 1..1 | Reference(Profile daf-core-patient) | Who the sensitivity is for |
| attestedDate | ∑ | 0..1 | dateTime | Date record was believed accurate |
| recorder | ∑ | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity |
| reporter | ∑ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy |
| onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
| lastOccurrence | ∑ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
| note | 0..* | Annotation | Additional text not captured in other fields | |
 reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| substance | ∑ | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Substance Code (example) |
| certainty | ∑ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required) |
| manifestation | ∑ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example) |
| description | 0..1 | string | Description of the event as a whole | |
| onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | ∑ | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | ∑ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
yet to be done: Xml template
yet to be done: Json template
This structure is derived from AllergyIntolerance
Differential View
This structure is derived from AllergyIntolerance
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
| id | ∑ | 0..1 | id | Logical id of this artifact |
| meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ∑ | 0..* | Identifier | External ids for this item |
| status | ?!S | 1..1 | code | active | active-confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required) |
| type | ∑ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | ∑ | 0..1 | code | food | medication | biologic | environment Binding: AllergyIntoleranceCategory (required) |
| criticality | ∑ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | S | 1..1 | CodeableConcept | Allergy or intolerance code Binding: DAF Substance-Reactant for Intolerance and Negation Codes (extensible) |
| patient | S | 1..1 | Reference(Profile daf-core-patient) | Who the sensitivity is for |
| attestedDate | ∑ | 0..1 | dateTime | Date record was believed accurate |
| recorder | ∑ | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity |
| reporter | ∑ | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy |
| onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
| lastOccurrence | ∑ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
| note | 0..* | Annotation | Additional text not captured in other fields | |
| reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| substance | ∑ | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Substance Code (example) |
| certainty | ∑ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required) |
| manifestation | ∑ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example) |
| description | 0..1 | string | Description of the event as a whole | |
| onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | ∑ | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | ∑ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| AllergyIntolerance.language | Common Languages | extensible | Common Languages |
| AllergyIntolerance.status | AllergyIntoleranceStatus | required | AllergyIntoleranceStatus |
| AllergyIntolerance.type | AllergyIntoleranceType | required | AllergyIntoleranceType |
| AllergyIntolerance.category | AllergyIntoleranceCategory | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | AllergyIntoleranceCriticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | DAF Substance-Reactant for Intolerance and Negation Codes | extensible | DAF Substance-Reactant for Intolerance and Negation Codes |
| AllergyIntolerance.reaction.substance | Substance Code | example | Substance Code |
| AllergyIntolerance.reaction.certainty | AllergyIntoleranceCertainty | required | AllergyIntoleranceCertainty |
| AllergyIntolerance.reaction.manifestation | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
| AllergyIntolerance.reaction.severity | AllergyIntoleranceSeverity | required | AllergyIntoleranceSeverity |
| AllergyIntolerance.reaction.exposureRoute | SNOMED CT Route Codes | example | SNOMED CT Route Codes |
| Id | Path | Details | Requirements |
| dom-2 | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
| dom-1 | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
| dom-4 | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
| dom-3 | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) |
© HL7.org 2011+. DAF STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change