Consolidated CDA (C-CDA)
5.0.0-ballot - STU5 Ballot 1 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ 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: 5.0.0-ballot
Draft as of 2026-03-10 Computable Name: AllergyIntoleranceObservation
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 4.0.0:

  • New Content

    • Formal Views of Template Content

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

    This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation SubstanceOrDeviceAllergyIntoleranceObservation XML Namespace: urn:hl7-org:v3
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... templateId 2..* II
    ... Slices for templateId Content/Rules for all slices
    .... templateId:allergy 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.7
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @negationInd 0..1 bl Use negationInd="true" to indicate that the allergy was not observed.
    ... Slices for participant Content/Rules for all slices
    .... participant:consumable 0..* Participant2 participant
    ..... participantRole
    ...... playingEntity
    ....... code 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Substance
    Binding: Common substances for allergy and intolerance documentation including refutations . (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.participant:consumable.​participantRole.playingEntity.​code Base preferred Common substances for allergy and intolerance documentation including refutations . ⏿20240625 tx.fhir.org
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 SubstanceOrDeviceAllergyIntoleranceObservation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-author, should-not-severity
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 2..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:substance-device-allergy-intolerance-obs 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.24.3.90
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    .... templateId:allergy 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.7
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl Use negationInd="true" to indicate that the allergy was not observed.
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: ASSERTION
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text C 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail C 0..1 ED Constraints: ED-1
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Fixed Value: completed
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    ... effectiveTime 1..1 IVL_TS If 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..1 cs Binding: CDANullFlavor (required)
    .... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    .... @operator 0..1 cs Binding: CDASetOperator (required)
    .... low 1..1 IVXB_TS
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD
    .... @code 1..1 cs Binding: Allergy and Intolerance Type . (required)
    .... @codeSystem 0..1 oid, uuid, ruid
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author C 0..* AuthorParticipation SHOULD contain author
    ... informant 0..* Informant
    ... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
    .... participant:consumable 0..* Participant2 participant
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    ..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
    XML: functionCode (urn:hl7-org:sdtc)
    ..... time 0..1 IVL_TS
    ..... awarenessCode 0..1 CE
    ..... participantRole 1..1 ParticipantRole
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ...... id 0..* II
    ...... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ...... code 0..1 CE Binding: CDARoleCode (example)
    ...... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
    XML: specialty (urn:hl7-org:sdtc)
    ...... addr 0..* AD
    ...... telecom 0..* TEL
    ...... playingDevice 0..1 Device
    ...... playingEntity 1..1 PlayingEntity
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... realmCode 0..* CS
    ....... typeId C 0..1 II Constraints: II-1
    ........ @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ........ @assigningAuthorityName 0..1 st
    ........ @displayable 0..1 bl
    ........ @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ........ @extension 1..1 st
    ....... templateId 0..* II
    ....... @classCode 1..1 cs Binding: EntityClassRoot (required)
    Fixed Value: MMAT
    ....... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ....... code 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Substance
    Binding: Common substances for allergy and intolerance documentation including refutations . (preferred)
    ....... quantity 0..* PQ
    ....... name 0..* PN
    ....... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ....... desc 0..1 ED
    ...... scopingEntity 0..1 Entity
    ... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:status 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 AllergyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:reaction 0..* EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: MFST
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 ReactionObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:severity C 0..1 EntryRelationship SHOULD NOT contain severity at the allergy level; severity belongs at the reaction level.
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SeverityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:criticality 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CriticalityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:allergy.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.classCode Base required CDAActClassObservation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v7.1
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v7.1
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v7.1
    Observation.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​operator Base required CDASetOperator 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v7.1
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value.code Base required Allergy and Intolerance Type . ⏿20250712 tx.fhir.org
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v7.1
    Observation.participant:consumable.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeCode Base required CDAParticipationType 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​contextControlCode Base required CDAContextControl 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.code Base example CDARoleCode 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​code Base preferred Common substances for allergy and intolerance documentation including refutations . ⏿20240625 tx.fhir.org
    Observation.entryRelationship:status.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:reaction.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:severity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:criticality.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.2-sd Clinical Document Architecture vnull

    Constraints

    Id Grade Path(s) Description Expression
    ED-1 error Observation.text.thumbnail Thumbnails cannot contain their own thumbnails thumbnail.empty()
    II-1 error Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-not-severity warning Observation Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 SubstanceOrDeviceAllergyIntoleranceObservation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-author, should-not-severity
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 2..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:substance-device-allergy-intolerance-obs 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.24.3.90
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    .... templateId:allergy 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.7
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl Use negationInd="true" to indicate that the allergy was not observed.
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: ASSERTION
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text C 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail C 0..1 ED Constraints: ED-1
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Fixed Value: completed
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    ... effectiveTime 1..1 IVL_TS If 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..1 cs Binding: CDANullFlavor (required)
    .... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    .... @operator 0..1 cs Binding: CDASetOperator (required)
    .... low 1..1 IVXB_TS
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD
    .... @code 1..1 cs Binding: Allergy and Intolerance Type . (required)
    .... @codeSystem 0..1 oid, uuid, ruid
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author C 0..* AuthorParticipation SHOULD contain author
    ... informant 0..* Informant
    ... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
    .... participant:consumable 0..* Participant2 participant
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    ..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
    XML: functionCode (urn:hl7-org:sdtc)
    ..... time 0..1 IVL_TS
    ..... awarenessCode 0..1 CE
    ..... participantRole 1..1 ParticipantRole
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ...... id 0..* II
    ...... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ...... code 0..1 CE Binding: CDARoleCode (example)
    ...... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
    XML: specialty (urn:hl7-org:sdtc)
    ...... addr 0..* AD
    ...... telecom 0..* TEL
    ...... playingDevice 0..1 Device
    ...... playingEntity 1..1 PlayingEntity
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... realmCode 0..* CS
    ....... typeId C 0..1 II Constraints: II-1
    ........ @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ........ @assigningAuthorityName 0..1 st
    ........ @displayable 0..1 bl
    ........ @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ........ @extension 1..1 st
    ....... templateId 0..* II
    ....... @classCode 1..1 cs Binding: EntityClassRoot (required)
    Fixed Value: MMAT
    ....... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ....... code 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Substance
    Binding: Common substances for allergy and intolerance documentation including refutations . (preferred)
    ....... quantity 0..* PQ
    ....... name 0..* PN
    ....... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ....... desc 0..1 ED
    ...... scopingEntity 0..1 Entity
    ... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:status 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 AllergyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:reaction 0..* EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: MFST
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 ReactionObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:severity C 0..1 EntryRelationship SHOULD NOT contain severity at the allergy level; severity belongs at the reaction level.
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SeverityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:criticality 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CriticalityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:allergy.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.classCode Base required CDAActClassObservation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v7.1
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v7.1
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v7.1
    Observation.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​operator Base required CDASetOperator 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v7.1
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value.code Base required Allergy and Intolerance Type . ⏿20250712 tx.fhir.org
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v7.1
    Observation.participant:consumable.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeCode Base required CDAParticipationType 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​contextControlCode Base required CDAContextControl 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.code Base example CDARoleCode 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​code Base preferred Common substances for allergy and intolerance documentation including refutations . ⏿20240625 tx.fhir.org
    Observation.entryRelationship:status.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:reaction.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:severity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:criticality.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.2-sd Clinical Document Architecture vnull

    Constraints

    Id Grade Path(s) Description Expression
    ED-1 error Observation.text.thumbnail Thumbnails cannot contain their own thumbnails thumbnail.empty()
    II-1 error Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-not-severity warning Observation Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

    Summary

    Mandatory: 3 elements

    Differential View

    This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation SubstanceOrDeviceAllergyIntoleranceObservation XML Namespace: urn:hl7-org:v3
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... templateId 2..* II
    ... Slices for templateId Content/Rules for all slices
    .... templateId:allergy 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.7
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @negationInd 0..1 bl Use negationInd="true" to indicate that the allergy was not observed.
    ... Slices for participant Content/Rules for all slices
    .... participant:consumable 0..* Participant2 participant
    ..... participantRole
    ...... playingEntity
    ....... code 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Substance
    Binding: Common substances for allergy and intolerance documentation including refutations . (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Observation.participant:consumable.​participantRole.playingEntity.​code Base preferred Common substances for allergy and intolerance documentation including refutations . ⏿20240625 tx.fhir.org

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 SubstanceOrDeviceAllergyIntoleranceObservation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-author, should-not-severity
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 2..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:substance-device-allergy-intolerance-obs 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.24.3.90
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    .... templateId:allergy 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.7
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl Use negationInd="true" to indicate that the allergy was not observed.
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: ASSERTION
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text C 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail C 0..1 ED Constraints: ED-1
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Fixed Value: completed
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    ... effectiveTime 1..1 IVL_TS If 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..1 cs Binding: CDANullFlavor (required)
    .... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    .... @operator 0..1 cs Binding: CDASetOperator (required)
    .... low 1..1 IVXB_TS
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD
    .... @code 1..1 cs Binding: Allergy and Intolerance Type . (required)
    .... @codeSystem 0..1 oid, uuid, ruid
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author C 0..* AuthorParticipation SHOULD contain author
    ... informant 0..* Informant
    ... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
    .... participant:consumable 0..* Participant2 participant
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    ..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
    XML: functionCode (urn:hl7-org:sdtc)
    ..... time 0..1 IVL_TS
    ..... awarenessCode 0..1 CE
    ..... participantRole 1..1 ParticipantRole
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ...... id 0..* II
    ...... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ...... code 0..1 CE Binding: CDARoleCode (example)
    ...... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
    XML: specialty (urn:hl7-org:sdtc)
    ...... addr 0..* AD
    ...... telecom 0..* TEL
    ...... playingDevice 0..1 Device
    ...... playingEntity 1..1 PlayingEntity
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... realmCode 0..* CS
    ....... typeId C 0..1 II Constraints: II-1
    ........ @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ........ @assigningAuthorityName 0..1 st
    ........ @displayable 0..1 bl
    ........ @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ........ @extension 1..1 st
    ....... templateId 0..* II
    ....... @classCode 1..1 cs Binding: EntityClassRoot (required)
    Fixed Value: MMAT
    ....... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ....... code 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Substance
    Binding: Common substances for allergy and intolerance documentation including refutations . (preferred)
    ....... quantity 0..* PQ
    ....... name 0..* PN
    ....... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ....... desc 0..1 ED
    ...... scopingEntity 0..1 Entity
    ... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:status 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 AllergyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:reaction 0..* EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: MFST
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 ReactionObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:severity C 0..1 EntryRelationship SHOULD NOT contain severity at the allergy level; severity belongs at the reaction level.
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SeverityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:criticality 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CriticalityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:allergy.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.classCode Base required CDAActClassObservation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v7.1
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v7.1
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v7.1
    Observation.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​operator Base required CDASetOperator 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v7.1
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value.code Base required Allergy and Intolerance Type . ⏿20250712 tx.fhir.org
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v7.1
    Observation.participant:consumable.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeCode Base required CDAParticipationType 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​contextControlCode Base required CDAContextControl 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.code Base example CDARoleCode 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​code Base preferred Common substances for allergy and intolerance documentation including refutations . ⏿20240625 tx.fhir.org
    Observation.entryRelationship:status.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:reaction.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:severity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:criticality.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.2-sd Clinical Document Architecture vnull

    Constraints

    Id Grade Path(s) Description Expression
    ED-1 error Observation.text.thumbnail Thumbnails cannot contain their own thumbnails thumbnail.empty()
    II-1 error Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-not-severity warning Observation Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Observation C 1..1 SubstanceOrDeviceAllergyIntoleranceObservation XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, should-author, should-not-severity
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    ... Slices for templateId 2..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:substance-device-allergy-intolerance-obs 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.24.3.90
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    .... templateId:allergy 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.7
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: CDAActClassObservation (required)
    Fixed Value: OBS
    ... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl Use negationInd="true" to indicate that the allergy was not observed.
    ... id 1..* II
    ... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
    XML: category (urn:hl7-org:sdtc)
    ... code 1..1 CD Binding: ObservationType (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: ASSERTION
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... derivationExpr 0..1 ST
    ... text C 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
    .... @integrityCheck 0..1 bin
    .... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
    .... @language 0..1 cs
    .... @mediaType 0..1 cs Binding: MediaType (example)
    .... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
    .... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail C 0..1 ED Constraints: ED-1
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Fixed Value: completed
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    ... effectiveTime 1..1 IVL_TS If 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..1 cs Binding: CDANullFlavor (required)
    .... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    .... @operator 0..1 cs Binding: CDASetOperator (required)
    .... low 1..1 IVXB_TS
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS
    ... priorityCode 0..1 CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... value 1..1 CD
    .... @code 1..1 cs Binding: Allergy and Intolerance Type . (required)
    .... @codeSystem 0..1 oid, uuid, ruid
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... qualifier 0..* CR
    .... translation 0..* CD
    ... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
    ... methodCode 0..* CE Binding: ObservationMethod (example)
    ... targetSiteCode 0..* CD
    ... subject 0..1 Subject
    ... specimen 0..* Specimen
    ... performer 0..* Performer2
    ... author C 0..* AuthorParticipation SHOULD contain author
    ... informant 0..* Informant
    ... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
    .... participant:consumable 0..* Participant2 participant
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: CSM
    ..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
    XML: functionCode (urn:hl7-org:sdtc)
    ..... time 0..1 IVL_TS
    ..... awarenessCode 0..1 CE
    ..... participantRole 1..1 ParticipantRole
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ...... id 0..* II
    ...... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ...... code 0..1 CE Binding: CDARoleCode (example)
    ...... sdtcSpecialty 0..* CE XML Namespace: urn:hl7-org:sdtc
    XML: specialty (urn:hl7-org:sdtc)
    ...... addr 0..* AD
    ...... telecom 0..* TEL
    ...... playingDevice 0..1 Device
    ...... playingEntity 1..1 PlayingEntity
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... realmCode 0..* CS
    ....... typeId C 0..1 II Constraints: II-1
    ........ @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ........ @assigningAuthorityName 0..1 st
    ........ @displayable 0..1 bl
    ........ @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ........ @extension 1..1 st
    ....... templateId 0..* II
    ....... @classCode 1..1 cs Binding: EntityClassRoot (required)
    Fixed Value: MMAT
    ....... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ....... code 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Substance
    Binding: Common substances for allergy and intolerance documentation including refutations . (preferred)
    ....... quantity 0..* PQ
    ....... name 0..* PN
    ....... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ....... desc 0..1 ED
    ...... scopingEntity 0..1 Entity
    ... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:status 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 AllergyStatusObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:reaction 0..* EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: MFST
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 ReactionObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:severity C 0..1 EntryRelationship SHOULD NOT contain severity at the allergy level; severity belongs at the reaction level.
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 SeverityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    .... entryRelationship:criticality 0..1 EntryRelationship entryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 1..1 bl Fixed Value: true
    ..... @contextConductionInd 0..1 bl
    ..... @negationInd 0..1 bl
    ..... sequenceNumber 0..1 INT
    ..... seperatableInd 0..1 BL
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 CriticalityObservation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 0..1 SubstanceAdministration
    ..... supply 0..1 Supply
    ... reference 0..* Reference
    ... precondition 0..* Precondition
    ... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
    XML: precondition2 (urn:hl7-org:sdtc)
    ... referenceRange 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
    Fixed Value: REFV
    .... observationRange 1..1 ObservationRange
    ... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
    XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Observation.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:substance-device-allergy-intolerance-obs.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.templateId:allergy.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.classCode Base required CDAActClassObservation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.moodCode Base required x_ActMoodDocumentObservation 📍2.0.0 THO v5.2
    Observation.code Base example ObservationType 📦3.0.0 THO v7.1
    Observation.code.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.compression Base required CDACompressionAlgorithm 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Observation.text.mediaType Base example MediaType 📦3.0.0 THO v7.1
    Observation.text.representation Base required CDABinaryDataEncoding 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.statusCode Base required ActStatus 📦3.0.0 THO v7.1
    Observation.statusCode.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.effectiveTime.​operator Base required CDASetOperator 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.priorityCode Base example ActPriority 📦3.0.0 THO v7.1
    Observation.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Observation.value.code Base required Allergy and Intolerance Type . ⏿20250712 tx.fhir.org
    Observation.interpretationCode Base required CDAObservationInterpretation 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.methodCode Base example ObservationMethod 📦3.0.0 THO v7.1
    Observation.participant:consumable.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​typeCode Base required CDAParticipationType 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​contextControlCode Base required CDAContextControl 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.classCode Base required CDARoleClassRoot 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.code Base example CDARoleCode 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.participant:consumable.​participantRole.playingEntity.​classCode Base required EntityClassRoot 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v7.1
    Observation.participant:consumable.​participantRole.playingEntity.​code Base preferred Common substances for allergy and intolerance documentation including refutations . ⏿20240625 tx.fhir.org
    Observation.entryRelationship:status.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:status.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:reaction.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:reaction.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:severity.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:severity.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.entryRelationship:criticality.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.entryRelationship:criticality.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v7.1
    Observation.referenceRange.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.2-sd Clinical Document Architecture vnull
    Observation.referenceRange.​typeCode Base required CDAActRelationshipType 📦2.0.2-sd Clinical Document Architecture vnull

    Constraints

    Id Grade Path(s) Description Expression
    ED-1 error Observation.text.thumbnail Thumbnails cannot contain their own thumbnails thumbnail.empty()
    II-1 error Observation.typeId, Observation.participant:consumable.typeId, Observation.participant:consumable.participantRole.typeId, Observation.participant:consumable.participantRole.playingEntity.typeId, Observation.entryRelationship:status.typeId, Observation.entryRelationship:reaction.typeId, Observation.entryRelationship:severity.typeId, Observation.entryRelationship:criticality.typeId, Observation.referenceRange.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Observation SHOULD contain author author.exists()
    should-not-severity warning Observation Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()
    should-text-ref-value warning Observation SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Observation.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation

    Summary

    Mandatory: 3 elements

     

    Other representations of profile: CSV, Excel