Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Allergy - Intolerance Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AllergyIntoleranceObservation Version: 2.1
Draft as of 2023-09-29 Computable Name: AllergyIntoleranceObservation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.7:2014-06-09

This template reflects a discrete observation about a patient’s allergy or intolerance. Because it is a discrete observation, it will have a statusCode of “completed”. The effectiveTime, also referred to as the “biologically relevant time” is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago.

The effectiveTime of the Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of “UNK”.

The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = “MMAT” for all agents, manufactured or not.

Usage:

Formal Views of Profile Content

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

This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange, classCode, moodCode, templateId, templateId, id, code, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
... classCode 1..1cs
... moodCode 1..1cs
... negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... templateId:secondary 1..1II
.... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.7
.... extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 1..1CD
.... code 1..1cs
.... codeSystem 1..1oid, uuid, ruid
... statusCode 1..1CS
.... code 1..1cs
... effectiveTime 1..1IVL_TSIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
.... low 1..1IVXB_TSThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
.... high 0..1IVXB_TSThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
... value 1..1CDThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
... author 0..*AuthorParticipationBase for all types and resources
... entryRelationship:criticality 0..1EntryRelationship
.... typeCode 1..1csFixed Value: SUBJ
.... inversionInd 1..1blFixed Value: true
.... observation 1..1CriticalityObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valuerequiredAllergy and Intolerance Type
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange, classCode, moodCode, templateId, templateId, id, code, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.24.3.90
..... @extension 1..1stRequired Pattern: 2014-06-09
.... templateId:secondary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.7
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
.... @code 1..1csRequired Pattern: ASSERTION
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
.... low 1..1IVXB_TSThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
.... high 0..1IVXB_TSThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
... value 1..1CDThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
.... @code 1..1csMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:participant1 0..*Participant2participant
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CSM
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: MMAT
....... code 1..1CEBinding: Substance Reactant for Intolerance (example)
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by value:typeCode, profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1AllergyStatusObservationBase for all types and resources
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: MFST
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1ReactionObservationBase for all types and resources
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1SeverityObservationBase for all types and resources
.... entryRelationship:entryRelationship4 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1CriticalityObservationBase for all types and resources
.... entryRelationship:criticality 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1CriticalityObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.valuerequiredAllergy and Intolerance Type
Observation.value.coderequiredAllergy and Intolerance Type
Observation.participant:participant1.typeCoderequiredFixed Value: CSM
Observation.participant:participant1.participantRole.classCoderequiredFixed Value: MANU
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
Observation.participant:participant1.participantRole.playingEntity.codeexampleSubstance Reactant for Intolerance
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:criticality.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange, classCode, moodCode, templateId, templateId, id, code, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.24.3.90
..... @extension 1..1stRequired Pattern: 2014-06-09
.... templateId:secondary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.7
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: ASSERTION
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TSThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
.... center 0..1TS
.... width 0..1PQ
.... high 0..1IVXB_TSThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1CDThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:participant1 0..*Participant2participant
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CSM
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
...... templateId 0..*II
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: v3 Code System RoleCode (extensible)
...... addr 0..*AD
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: MMAT
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 1..1CEBinding: Substance Reactant for Intolerance (example)
....... quantity 0..*PQ
....... name 0..*PN
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by value:typeCode, profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1AllergyStatusObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: MFST
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1ReactionObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1SeverityObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship4 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1CriticalityObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:criticality 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1CriticalityObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:templateId1.nullFlavorrequiredNullFlavor
Observation.templateId:secondary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.code.nullFlavorrequiredNullFlavor
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.valuerequiredAllergy and Intolerance Type
Observation.value.nullFlavorrequiredNullFlavor
Observation.value.coderequiredAllergy and Intolerance Type
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.participant:participant1.nullFlavorrequiredNullFlavor
Observation.participant:participant1.typeCoderequiredFixed Value: CSM
Observation.participant:participant1.contextControlCoderequiredFixed Value: OP
Observation.participant:participant1.participantRole.classCoderequiredFixed Value: MANU
Observation.participant:participant1.participantRole.codeextensibleRoleCode
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
Observation.participant:participant1.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant1.participantRole.playingEntity.codeexampleSubstance Reactant for Intolerance
Observation.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:criticality.nullFlavorrequiredNullFlavor
Observation.entryRelationship:criticality.typeCoderequiredFixed Value: SUBJ
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange, classCode, moodCode, templateId, templateId, id, code, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
... classCode 1..1cs
... moodCode 1..1cs
... negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... templateId:secondary 1..1II
.... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.7
.... extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 1..1CD
.... code 1..1cs
.... codeSystem 1..1oid, uuid, ruid
... statusCode 1..1CS
.... code 1..1cs
... effectiveTime 1..1IVL_TSIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
.... low 1..1IVXB_TSThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
.... high 0..1IVXB_TSThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
... value 1..1CDThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
... author 0..*AuthorParticipationBase for all types and resources
... entryRelationship:criticality 0..1EntryRelationship
.... typeCode 1..1csFixed Value: SUBJ
.... inversionInd 1..1blFixed Value: true
.... observation 1..1CriticalityObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valuerequiredAllergy and Intolerance Type

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange, classCode, moodCode, templateId, templateId, id, code, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.24.3.90
..... @extension 1..1stRequired Pattern: 2014-06-09
.... templateId:secondary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.7
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
.... @code 1..1csRequired Pattern: ASSERTION
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
.... low 1..1IVXB_TSThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
.... high 0..1IVXB_TSThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
... value 1..1CDThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
.... @code 1..1csMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
... author 0..*AuthorParticipationBase for all types and resources
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:participant1 0..*Participant2participant
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CSM
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: MMAT
....... code 1..1CEBinding: Substance Reactant for Intolerance (example)
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by value:typeCode, profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1AllergyStatusObservationBase for all types and resources
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: MFST
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1ReactionObservationBase for all types and resources
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1SeverityObservationBase for all types and resources
.... entryRelationship:entryRelationship4 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1CriticalityObservationBase for all types and resources
.... entryRelationship:criticality 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1CriticalityObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.valuerequiredAllergy and Intolerance Type
Observation.value.coderequiredAllergy and Intolerance Type
Observation.participant:participant1.typeCoderequiredFixed Value: CSM
Observation.participant:participant1.participantRole.classCoderequiredFixed Value: MANU
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
Observation.participant:participant1.participantRole.playingEntity.codeexampleSubstance Reactant for Intolerance
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:criticality.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange, classCode, moodCode, templateId, templateId, id, code, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.24.3.90
..... @extension 1..1stRequired Pattern: 2014-06-09
.... templateId:secondary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.7
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: ASSERTION
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TSThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
.... center 0..1TS
.... width 0..1PQ
.... high 0..1IVXB_TSThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 1..1CDThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:participant1 0..*Participant2participant
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CSM
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
...... templateId 0..*II
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: v3 Code System RoleCode (extensible)
...... addr 0..*AD
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 1..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: MMAT
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 1..1CEBinding: Substance Reactant for Intolerance (example)
....... quantity 0..*PQ
....... name 0..*PN
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by value:typeCode, profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1AllergyStatusObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: MFST
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1ReactionObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act