Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Allergy - Intolerance Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AllergyIntoleranceObservation Version: 3.0.0-ballot
Draft as of 2023-12-21 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: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... templateId 2..*II
... templateId:allergy 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
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... participant:participant1 0..*Participant2participant
.... participantRole
..... playingEntity
...... code 1..1CE(USCDI) Substance
Binding: Common substances for allergy and intolerance documentation including refutations (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.participant:participant1.participantRole.playingEntity.codepreferredCommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:substance-device-allergy-intolerance-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.24.3.90
..... @extension 1..1stRequired Pattern: 2014-06-09
.... templateId:allergy 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
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... id 1..*II
... code 1..1CDBinding: ObservationType (example)
.... @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_TS
... value 1..1CD
.... @code 1..1csMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
... 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..1CE(USCDI) Substance
Binding: Common substances for allergy and intolerance documentation including refutations (preferred)
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation C1..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 C1..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 C1..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 C1..1CriticalityObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.statusCoderequiredActStatus
Observation.value.coderequiredAllergyAndIntoleranceType
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.codepreferredCommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:entryRelationship2.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:entryRelationship1.observation, Observation.entryRelationship:entryRelationship2.observation, Observation.entryRelationship:entryRelationship3.observation, Observation.entryRelationship:entryRelationship4.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:substance-device-allergy-intolerance-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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:allergy 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... id 1..*II
... code 1..1CDBinding: ObservationType (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TEL
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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: CDANullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 0..1TS
.... width 0..1PQ
.... high 0..1IVXB_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value 1..1CD
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... 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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CSM
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: v3 Code System RoleCode (example)
...... addr 0..*AD
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 1..1PlayingEntity
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
........ @nullFlavor 0..1csBinding: CDANullFlavor (required)
........ @assigningAuthorityName 0..1st
........ @displayable 0..1bl
........ @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
........ @extension 1..1st
....... templateId 0..*II
....... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: MMAT
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... code 1..1CE(USCDI) Substance
Binding: Common substances for allergy and intolerance documentation including refutations (preferred)
....... 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 profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:substance-device-allergy-intolerance-obs.nullFlavorrequiredCDANullFlavor
Observation.templateId:allergy.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.code.nullFlavorrequiredCDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.value.nullFlavorrequiredCDANullFlavor
Observation.value.coderequiredAllergyAndIntoleranceType
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.participant:participant1.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.typeCoderequiredFixed Value: CSM
Observation.participant:participant1.contextControlCoderequiredFixed Value: OP
Observation.participant:participant1.participantRole.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.classCoderequiredFixed Value: MANU
Observation.participant:participant1.participantRole.codeexampleRoleCode
Observation.participant:participant1.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
Observation.participant:participant1.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant1.participantRole.playingEntity.codepreferredCommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations
Observation.entryRelationship:entryRelationship1.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship1.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship2.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship3.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship4.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:entryRelationship2.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:entryRelationship1.observation, Observation.entryRelationship:entryRelationship2.observation, Observation.entryRelationship:entryRelationship3.observation, Observation.entryRelationship:entryRelationship4.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf 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 & Constraintsdoco
.. Observation SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... templateId 2..*II
... templateId:allergy 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
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... participant:participant1 0..*Participant2participant
.... participantRole
..... playingEntity
...... code 1..1CE(USCDI) Substance
Binding: Common substances for allergy and intolerance documentation including refutations (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.participant:participant1.participantRole.playingEntity.codepreferredCommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:substance-device-allergy-intolerance-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.24.3.90
..... @extension 1..1stRequired Pattern: 2014-06-09
.... templateId:allergy 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
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... id 1..*II
... code 1..1CDBinding: ObservationType (example)
.... @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_TS
... value 1..1CD
.... @code 1..1csMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Binding: Allergy and Intolerance Type (required)
... 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..1CE(USCDI) Substance
Binding: Common substances for allergy and intolerance documentation including refutations (preferred)
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... observation C1..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 C1..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 C1..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 C1..1CriticalityObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.statusCoderequiredActStatus
Observation.value.coderequiredAllergyAndIntoleranceType
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.codepreferredCommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:entryRelationship2.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:entryRelationship1.observation, Observation.entryRelationship:entryRelationship2.observation, Observation.entryRelationship:entryRelationship3.observation, Observation.entryRelationship:entryRelationship4.observationSHOULD contain text/reference/@value
: text.reference.value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SubstanceOrDeviceAllergyIntoleranceObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, participant, participant, entryRelationship, entryRelationship, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:substance-device-allergy-intolerance-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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:allergy 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1blUse negationInd="true" to indicate that the allergy was not observed.
... id 1..*II
... code 1..1CDBinding: ObservationType (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TEL
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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: CDANullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 0..1TS
.... width 0..1PQ
.... high 0..1IVXB_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value 1..1CD
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... 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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: CSM
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
...... id 0..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: v3 Code System RoleCode (example)
...... addr 0..*AD
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 1..1PlayingEntity
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
........ @nullFlavor 0..1csBinding: CDANullFlavor (required)
........ @assigningAuthorityName 0..1st
........ @displayable 0..1bl
........ @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
........ @extension 1..1st
....... templateId 0..*II
....... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: MMAT
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... code 1..1CE(USCDI) Substance
Binding: Common substances for allergy and intolerance documentation including refutations (preferred)
....... 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 profile:observation
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:substance-device-allergy-intolerance-obs.nullFlavorrequiredCDANullFlavor
Observation.templateId:allergy.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.code.nullFlavorrequiredCDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.value.nullFlavorrequiredCDANullFlavor
Observation.value.coderequiredAllergyAndIntoleranceType
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.participant:participant1.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.typeCoderequiredFixed Value: CSM
Observation.participant:participant1.contextControlCoderequiredFixed Value: OP
Observation.participant:participant1.participantRole.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.classCoderequiredFixed Value: MANU
Observation.participant:participant1.participantRole.codeexampleRoleCode
Observation.participant:participant1.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
Observation.participant:participant1.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
Observation.participant:participant1.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Observation.participant:participant1.participantRole.playingEntity.codepreferredCommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations
Observation.entryRelationship:entryRelationship1.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship1.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship2.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship2.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: MFST
Observation.entryRelationship:entryRelationship3.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship3.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: SUBJ
Observation.entryRelationship:entryRelationship4.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship4.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: SUBJ
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:entryRelationship2.observationSHOULD contain effectiveTime
: effectiveTime.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:entryRelationship1.observation, Observation.entryRelationship:entryRelationship2.observation, Observation.entryRelationship:entryRelationship3.observation, Observation.entryRelationship:entryRelationship4.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf 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