2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: cqf-allergyintolerance

The official URL for this profile is:

http://hl7.org/fhir/Profile/cqf-allergyintolerance-cqf-allergyintolerance

. Profile of AllergyIntolerance for decision support/quality metrics. Indicates which elements must be supported by CQF rules and measure engines. Removes modifying attributes. : Clinical Quality Framework (CQF) AllergyIntolerance Profile

This profile was published on Mon, Nov 3, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.

Summary

Terminology Bindings

  • AllergyIntolerance.status must come from Value set for AllergyIntolerance Status for non-refuted values.

Required/Prohibited Elements

  • The element AllergyIntolerance is required
  • The element AllergyIntolerance.subject is required
  • The element AllergyIntolerance.substance is required
  • The element AllergyIntolerance.event.manifestation is required

Formal Views of Profile Content

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

Differential View

This structure is derived from AllergyIntolerance.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 1..1Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... recordedDate S Σ0..1dateTimeWhen recorded
... recorder S Σ0..1Practitioner, PatientWho recorded the sensitivity
... subject S Σ1..1PatientWho the sensitivity is for
... substance S Σ1..1CodeableConceptSubstance, (or class) considered to be responsible for risk
Binding: SubstanceType (example, extensible)
... status M SΣ0..1codeunconfirmed | confirmed | resolved
Binding: valuesetAllergyIntoleranceStatusPresent (required, not extensible)
... criticality S Σ0..1codelow | high | unassessible - Estimated potential clinical harm
Binding: AllergyIntoleranceCriticality (required, not extensible)
... type S Σ0..1codeimmune | non-immune - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required, not extensible)
... category S Σ0..1codefood | medication | environment - Category of Substance
Binding: AllergyIntoleranceCategory (required, not extensible)
... lastOccurence Σ0..1dateTimeDate(/time) of last known occurence of a reaction
... comment 0..1stringAdditional text not captured in other fields
... event S0..*Adverse Reaction Events linked to exposure to substance
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... substance S Σ0..1CodeableConceptSpecific substance considered to be responsible for event
Binding: SubstanceType (example, extensible)
.... certainty S Σ0..1codeunlikely | likely | confirmed - clinical certainty about the specific substance
Binding: AllergyIntoleranceCertainty (required, not extensible)
.... manifestation Σ1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Manifestation (example, extensible)
.... description 0..1stringDescription of the event as a whole
.... onset S Σ0..1dateTimeDate(/time) when manifestations showed
.... duration S0..1DurationHow long Manifestations persisted
.... severity S Σ0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required, not extensible)
.... exposureRoute S Σ0..1CodeableConceptHow the subject was exposed to the substance
Binding: RouteOfAdministration (example, extensible)
.... comment 0..1stringText about event not captured in other fields

XML Template

JSON Template

todo

Differential View

This structure is derived from AllergyIntolerance.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 1..1Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... recordedDate S Σ0..1dateTimeWhen recorded
... recorder S Σ0..1Practitioner, PatientWho recorded the sensitivity
... subject S Σ1..1PatientWho the sensitivity is for
... substance S Σ1..1CodeableConceptSubstance, (or class) considered to be responsible for risk
Binding: SubstanceType (example, extensible)
... status M SΣ0..1codeunconfirmed | confirmed | resolved
Binding: valuesetAllergyIntoleranceStatusPresent (required, not extensible)
... criticality S Σ0..1codelow | high | unassessible - Estimated potential clinical harm
Binding: AllergyIntoleranceCriticality (required, not extensible)
... type S Σ0..1codeimmune | non-immune - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required, not extensible)
... category S Σ0..1codefood | medication | environment - Category of Substance
Binding: AllergyIntoleranceCategory (required, not extensible)
... lastOccurence Σ0..1dateTimeDate(/time) of last known occurence of a reaction
... comment 0..1stringAdditional text not captured in other fields
... event S0..*Adverse Reaction Events linked to exposure to substance
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... substance S Σ0..1CodeableConceptSpecific substance considered to be responsible for event
Binding: SubstanceType (example, extensible)
.... certainty S Σ0..1codeunlikely | likely | confirmed - clinical certainty about the specific substance
Binding: AllergyIntoleranceCertainty (required, not extensible)
.... manifestation Σ1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: Manifestation (example, extensible)
.... description 0..1stringDescription of the event as a whole
.... onset S Σ0..1dateTimeDate(/time) when manifestations showed
.... duration S0..1DurationHow long Manifestations persisted
.... severity S Σ0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required, not extensible)
.... exposureRoute S Σ0..1CodeableConceptHow the subject was exposed to the substance
Binding: RouteOfAdministration (example, extensible)
.... comment 0..1stringText about event not captured in other fields

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
AllergyIntolerance.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
AllergyIntolerance.substanceSubstanceTypeexample (extensible)Substance Type
AllergyIntolerance.statusvaluesetAllergyIntoleranceStatusPresentrequiredAllergyIntoleranceStatusPresent
AllergyIntolerance.criticalityAllergyIntoleranceCriticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.typeAllergyIntoleranceTyperequiredAllergyIntoleranceType
AllergyIntolerance.categoryAllergyIntoleranceCategoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.event.substanceSubstanceTypeexample (extensible)Substance Type
AllergyIntolerance.event.certaintyAllergyIntoleranceCertaintyrequiredAllergyIntoleranceCertainty
AllergyIntolerance.event.manifestationManifestationexample (extensible)SNOMED CT Clinical Findings
AllergyIntolerance.event.severityAllergyIntoleranceSeverityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.event.exposureRouteRouteOfAdministrationexample (extensible)SNOMED CT Route Codes

Constraints

IdPathNameDetails
.