GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

F.3.1 StructureDefinition: QICore-AllergyIntolerance

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/qicore-allergyintolerance

Profile of AllergyIntolerance for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

F.3.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
inv-1: extension: reasonRefuted is only permitted if status is refuted
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... allergyintolerance-resolutionAge 0..1AgeExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
... allergyintolerance-reasonRefuted 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
Binding: Reasons for refuting allergy or intolerance codes (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierExternal ids for this item
... onset ∑0..1dateTimeDate(/time) when manifestations showed
... recordedDate S ∑0..1dateTimeWhen recorded
... recorder ∑0..1Reference(QICore-Practitioner | QICore-Patient)Who recorded the sensitivity
... patient S ∑1..1Reference(QICore-Patient)Who the sensitivity is for
... reporter ∑0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... substance S ∑1..1CodeableConceptSubstance, (or class) considered to be responsible for risk
Binding: DAF Substance-Reactant for Intolerance and Negation Codes (preferred)
... status ?! S∑0..1codeactive | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
Binding: AllergyIntoleranceStatus (required)
... criticality S ∑0..1codeCRITL | CRITH | CRITU
Binding: AllergyIntoleranceCriticality (required)
... type S ∑0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category S ∑0..1codefood | medication | environment | other - Category of Substance
Binding: AllergyIntoleranceCategory (required)
... lastOccurence ∑0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..1AnnotationAdditional text not captured in other fields
... reaction 0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... allergyintolerance-duration S0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... substance ∑0..1CodeableConceptSpecific substance considered to be responsible for event
Binding: Substance Code (example)
.... certainty ∑0..1codeunlikely | likely | confirmed - clinical certainty about the specific substance
Binding: AllergyIntoleranceCertainty (required)
.... manifestation S ∑1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Manifestation C-CDA codes (preferred)
.... description 0..1stringDescription of the event as a whole
.... onset S ∑0..1dateTimeDate(/time) when manifestations showed
.... severity ∑0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute ∑0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..1AnnotationText about event not captured in other fields

doco Documentation for this format

todo

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
inv-1: extension: reasonRefuted is only permitted if status is refuted
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... allergyintolerance-resolutionAge 0..1AgeExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
... allergyintolerance-reasonRefuted 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
Binding: Reasons for refuting allergy or intolerance codes (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierExternal ids for this item
... onset ∑0..1dateTimeDate(/time) when manifestations showed
... recordedDate S ∑0..1dateTimeWhen recorded
... recorder ∑0..1Reference(QICore-Practitioner | QICore-Patient)Who recorded the sensitivity
... patient S ∑1..1Reference(QICore-Patient)Who the sensitivity is for
... reporter ∑0..1Reference(Patient | RelatedPerson | Practitioner)Source of the information about the allergy
... substance S ∑1..1CodeableConceptSubstance, (or class) considered to be responsible for risk
Binding: DAF Substance-Reactant for Intolerance and Negation Codes (preferred)
... status ?! S∑0..1codeactive | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
Binding: AllergyIntoleranceStatus (required)
... criticality S ∑0..1codeCRITL | CRITH | CRITU
Binding: AllergyIntoleranceCriticality (required)
... type S ∑0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category S ∑0..1codefood | medication | environment | other - Category of Substance
Binding: AllergyIntoleranceCategory (required)
... lastOccurence ∑0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..1AnnotationAdditional text not captured in other fields
... reaction 0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... allergyintolerance-duration S0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... substance ∑0..1CodeableConceptSpecific substance considered to be responsible for event
Binding: Substance Code (example)
.... certainty ∑0..1codeunlikely | likely | confirmed - clinical certainty about the specific substance
Binding: AllergyIntoleranceCertainty (required)
.... manifestation S ∑1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Manifestation C-CDA codes (preferred)
.... description 0..1stringDescription of the event as a whole
.... onset S ∑0..1dateTimeDate(/time) when manifestations showed
.... severity ∑0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute ∑0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMED CT Route Codes (example)
.... note 0..1AnnotationText about event not captured in other fields

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

F.3.1.2 Terminology Bindings

PathNameConformanceValueSet
AllergyIntolerance.language?extrequiredhttp://tools.ietf.org/html/bcp47
AllergyIntolerance.extension
[UriType[http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted]]		Reasons for refuting allergy or intolerance codesexampleReasons for refuting allergy or intolerance codes
AllergyIntolerance.substanceDAF Substance-Reactant for Intolerance and Negation CodespreferredDAF Substance-Reactant for Intolerance and Negation Codes
AllergyIntolerance.statusAllergyIntoleranceStatusrequiredAllergyIntoleranceStatus
AllergyIntolerance.criticalityAllergyIntoleranceCriticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.typeAllergyIntoleranceTyperequiredAllergyIntoleranceType
AllergyIntolerance.categoryAllergyIntoleranceCategoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.reaction.substanceSubstance CodeexampleSubstance Code
AllergyIntolerance.reaction.certaintyAllergyIntoleranceCertaintyrequiredAllergyIntoleranceCertainty
AllergyIntolerance.reaction.manifestationManifestation C-CDA codespreferredManifestation C-CDA codes
AllergyIntolerance.reaction.severityAllergyIntoleranceSeverityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteSNOMED CT Route CodesexampleSNOMED CT Route Codes

F.3.1.3 Constraints

IdPathDetailsRequirements
inv-1AllergyIntoleranceextension: reasonRefuted is only permitted if status is refuted
XPath: not(f:status/@value != 'refuted' and f:extension/@url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted')
.