Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.7 | Version: 2.1.0-draft1 | |||
| Active as of 2023-01-16 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources | |
  classCode | 1..1 | code | Required Pattern: OBS | |
| moodCode | 1..1 | code | Required Pattern: EVN | |
| negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
  Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:secondary | 1..1 | II | ||
  root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
  extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | string | Required Pattern: ASSERTION | |
 codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | string | Required Pattern: completed | |
| 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'. | |
| low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
| high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
| value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
 Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:observation | |
| entryRelationship:criticality | 0..1 | Element | ||
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| observation | 1..1 | CriticalityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value | required | Allergy and Intolerance Type |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources | |
 classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
| moodCode | 1..1 | code | Required Pattern: EVN | |
| negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
 templateId:primary | 1..1 | II | ||
 root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| templateId:secondary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| code | 1..1 | string | Required Pattern: ASSERTION | |
| codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| code | 1..1 | string | Required Pattern: completed | |
| 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'. | |
| low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
| high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
| value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| code | 1..1 | string | Many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:participant1 | 0..* | Participant2 | ||
| typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: CSM | |
 participantRole | 1..1 | ParticipantRole | ||
| classCode | 1..1 | code | Binding: RoleClassRoot (required) Required Pattern: MANU | |
| playingEntity | 1..1 | PlayingEntity | ||
| classCode | 1..1 | code | Binding: EntityClassRoot (required) Required Pattern: MMAT | |
| determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code | 1..1 | CE | Binding: Substance Reactant for Intolerance (example) | |
| Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by profile:observation |
| entryRelationship:allergyStatus | C | 0..1 | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | AllergyStatusObservation | Base for all types and resources | |
| entryRelationship:reaction | C | 0..* | Element | |
| typeCode | 1..1 | code | Required Pattern: MFST | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | ReactionObservation | Base for all types and resources | |
| entryRelationship:severity | C | 0..1 | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| entryRelationship:criticality | C | 0..1 | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | CriticalityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Pattern: OBS |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.value | required | Allergy and Intolerance Type |
| Observation.value.code | required | Allergy and Intolerance Type |
| Observation.participant:participant1.typeCode | required | Pattern: CSM |
| Observation.participant:participant1.participantRole.classCode | required | Pattern: MANU |
| Observation.participant:participant1.participantRole.playingEntity.classCode | required | Pattern: MMAT |
| Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
| Observation.participant:participant1.participantRole.playingEntity.code | example | Substance Reactant for Intolerance |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:allergyStatus, Observation.entryRelationship:reaction, Observation.entryRelationship:severity, Observation.entryRelationship:criticality | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources | |
| classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
| moodCode | 1..1 | code | Required Pattern: EVN | |
| negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| assigningAuthorityName | 0..1 | string | ||
| displayable | 0..1 | boolean | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| templateId:secondary | 1..1 | II | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| assigningAuthorityName | 0..1 | string | ||
| displayable | 0..1 | boolean | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Required Pattern: ASSERTION | |
| codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
| codeSystemName | 0..1 | string | ||
| codeSystemVersion | 0..1 | string | ||
| displayName | 0..1 | string | ||
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| qualifier | 0..* | CR | ||
| translation | 0..* | CD | ||
| derivationExpr | 0..1 | ED | ||
| text | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Required Pattern: completed | |
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | 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 | code | Binding: NullFlavor (required) | |
| value | 0..1 | dateTime | ||
| inclusive | 0..1 | boolean | ||
| operator | 0..1 | code | ||
| low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
| high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
| width | 0..1 | PQ | ||
| center | 0..1 | TS | ||
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| repeatNumber | 0..1 | IVL_INT | ||
| languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
| value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| codeSystem | 0..1 | string | ||
| codeSystemName | 0..1 | string | ||
| codeSystemVersion | 0..1 | string | ||
| displayName | 0..1 | string | ||
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| qualifier | 0..* | CR | ||
| translation | 0..* | CD | ||
| interpretationCode | 0..* | CE | Binding: ObservationInterpretation (required) | |
| methodCode | 0..* | CE | Binding: ObservationMethod (extensible) | |
| targetSiteCode | 0..* | CD | ||
 subject | 0..1 | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
| relatedSubject | 1..1 | RelatedSubject | ||
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | ||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| informant | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| assignedEntity | 0..1 | AssignedEntity | ||
| relatedEntity | 0..1 | RelatedEntity | ||
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:participant1 | 0..* | Participant2 | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: CSM | |
| contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |
| time | 0..1 | IVL_TS | ||
| awarenessCode | 0..1 | CE | ||
| participantRole | 1..1 | ParticipantRole | ||
| classCode | 1..1 | code | Binding: RoleClassRoot (required) Required Pattern: MANU | |
| templateId | 0..* | II | ||
| id | 0..* | II | ||
| sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |
| code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| playingDevice | 0..1 | Device | ||
| playingEntity | 1..1 | PlayingEntity | ||
| classCode | 1..1 | code | Binding: EntityClassRoot (required) Required Pattern: MMAT | |
| determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| code | 1..1 | CE | Binding: Substance Reactant for Intolerance (example) | |
| quantity | 0..* | PQ | ||
| name | 0..* | EN | ||
| desc | 0..1 | ED | ||
| scopingEntity | 0..1 | Entity | ||
| Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by profile:observation |
| entryRelationship:allergyStatus | C | 0..1 | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | AllergyStatusObservation | Base for all types and resources | |
| entryRelationship:reaction | C | 0..* | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: MFST | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | ReactionObservation | Base for all types and resources | |
| entryRelationship:severity | C | 0..1 | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| entryRelationship:criticality | C | 0..1 | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | CriticalityObservation | Base for all types and resources | |
| reference | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | ||
| seperatableInd | 0..1 | BL | ||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| precondition | 0..* | Precondition | ||
| referenceRange | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
| observationRange | 1..1 | ObservationRange | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Pattern: OBS |
| Observation.templateId:primary.nullFlavor | required | NullFlavor |
| Observation.templateId:secondary.nullFlavor | required | NullFlavor |
| Observation.code | extensible | ObservationType |
| Observation.code.nullFlavor | required | NullFlavor |
| Observation.statusCode | required | ActStatus |
| Observation.statusCode.nullFlavor | required | NullFlavor |
| Observation.effectiveTime.nullFlavor | required | NullFlavor |
| Observation.priorityCode | extensible | ActPriority |
| Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Observation.value | required | Allergy and Intolerance Type |
| Observation.value.nullFlavor | required | NullFlavor |
| Observation.value.code | required | Allergy and Intolerance Type |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | extensible | ObservationMethod |
| Observation.subject.typeCode | required | Fixed Value: SBJ |
| Observation.subject.contextControlCode | required | Fixed Value: OP |
| Observation.subject.awarenessCode | extensible | TargetAwareness |
| Observation.informant.typeCode | required | Fixed Value: INF |
| Observation.informant.contextControlCode | required | Fixed Value: OP |
| Observation.participant:participant1.nullFlavor | required | NullFlavor |
| Observation.participant:participant1.typeCode | required | Pattern: CSM |
| Observation.participant:participant1.contextControlCode | required | Fixed Value: OP |
| Observation.participant:participant1.participantRole.classCode | required | Pattern: MANU |
| Observation.participant:participant1.participantRole.code | extensible | RoleCode |
| Observation.participant:participant1.participantRole.playingEntity.classCode | required | Pattern: MMAT |
| Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
| Observation.participant:participant1.participantRole.playingEntity.code | example | Substance Reactant for Intolerance |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:allergyStatus, Observation.entryRelationship:reaction, Observation.entryRelationship:severity, Observation.entryRelationship:criticality | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
Summary
Mandatory: 14 elements (3 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources | |
| classCode | 1..1 | code | Required Pattern: OBS | |
| moodCode | 1..1 | code | Required Pattern: EVN | |
| negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:secondary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | string | Required Pattern: ASSERTION | |
| codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | string | Required Pattern: completed | |
| 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'. | |
| low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
| high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
| value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for entryRelationship | 0..* | Element | Slice: Unordered, Open by profile:observation | |
| entryRelationship:criticality | 0..1 | Element | ||
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| observation | 1..1 | CriticalityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value | required | Allergy and Intolerance Type |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources | |
| classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
| moodCode | 1..1 | code | Required Pattern: EVN | |
| negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| templateId:secondary | 1..1 | II | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| code | 1..1 | string | Required Pattern: ASSERTION | |
| codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| code | 1..1 | string | Required Pattern: completed | |
| 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'. | |
| low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
| high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
| value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| code | 1..1 | string | Many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:participant1 | 0..* | Participant2 | ||
| typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: CSM | |
| participantRole | 1..1 | ParticipantRole | ||
| classCode | 1..1 | code | Binding: RoleClassRoot (required) Required Pattern: MANU | |
| playingEntity | 1..1 | PlayingEntity | ||
| classCode | 1..1 | code | Binding: EntityClassRoot (required) Required Pattern: MMAT | |
| determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code | 1..1 | CE | Binding: Substance Reactant for Intolerance (example) | |
| Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by profile:observation |
| entryRelationship:allergyStatus | C | 0..1 | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | AllergyStatusObservation | Base for all types and resources | |
| entryRelationship:reaction | C | 0..* | Element | |
| typeCode | 1..1 | code | Required Pattern: MFST | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | ReactionObservation | Base for all types and resources | |
| entryRelationship:severity | C | 0..1 | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| entryRelationship:criticality | C | 0..1 | Element | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| observation | 1..1 | CriticalityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Pattern: OBS |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.value | required | Allergy and Intolerance Type |
| Observation.value.code | required | Allergy and Intolerance Type |
| Observation.participant:participant1.typeCode | required | Pattern: CSM |
| Observation.participant:participant1.participantRole.classCode | required | Pattern: MANU |
| Observation.participant:participant1.participantRole.playingEntity.classCode | required | Pattern: MMAT |
| Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
| Observation.participant:participant1.participantRole.playingEntity.code | example | Substance Reactant for Intolerance |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:allergyStatus, Observation.entryRelationship:reaction, Observation.entryRelationship:severity, Observation.entryRelationship:criticality | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources | |
| classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
| moodCode | 1..1 | code | Required Pattern: EVN | |
| negationInd | 0..1 | boolean | Use negationInd="true" to indicate that the allergy was not observed. | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| assigningAuthorityName | 0..1 | string | ||
| displayable | 0..1 | boolean | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| templateId:secondary | 1..1 | II | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| assigningAuthorityName | 0..1 | string | ||
| displayable | 0..1 | boolean | ||
| root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.7 | |
| extension | 1..1 | string | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Required Pattern: ASSERTION | |
| codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
| codeSystemName | 0..1 | string | ||
| codeSystemVersion | 0..1 | string | ||
| displayName | 0..1 | string | ||
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| qualifier | 0..* | CR | ||
| translation | 0..* | CD | ||
| derivationExpr | 0..1 | ED | ||
| text | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Required Pattern: completed | |
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | 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 | code | Binding: NullFlavor (required) | |
| value | 0..1 | dateTime | ||
| inclusive | 0..1 | boolean | ||
| operator | 0..1 | code | ||
| low | 1..1 | TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active. | |
| high | 0..1 | TS | The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved. | |
| width | 0..1 | PQ | ||
| center | 0..1 | TS | ||
| priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
| repeatNumber | 0..1 | IVL_INT | ||
| languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
| value | 1..1 | CD | The consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| code | 1..1 | string | Many systems will simply assign a fixed value here (e.g., "allergy to substance"). Binding: Allergy and Intolerance Type (required) | |
| codeSystem | 0..1 | string | ||
| codeSystemName | 0..1 | string | ||
| codeSystemVersion | 0..1 | string | ||
| displayName | 0..1 | string | ||
| sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
| sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| qualifier | 0..* | CR | ||
| translation | 0..* | CD | ||
| interpretationCode | 0..* | CE | Binding: ObservationInterpretation (required) | |
| methodCode | 0..* | CE | Binding: ObservationMethod (extensible) | |
| targetSiteCode | 0..* | CD | ||
| subject | 0..1 | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
| relatedSubject | 1..1 | RelatedSubject | ||
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | ||
| author | 0..* | AuthorParticipation | Base for all types and resources | |
| informant | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
| contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| assignedEntity | 0..1 | AssignedEntity | ||
| relatedEntity | 0..1 | RelatedEntity | ||
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:participant1 | 0..* | Participant2 | ||
| nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
| typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: CSM | |
| contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |
| time | 0..1 | IVL_TS | ||
| awarenessCode | 0..1 | CE | ||
| participantRole | 1..1 | ParticipantRole | ||
| classCode | 1..1 | code | Binding: RoleClassRoot (required) Required Pattern: MANU | |
| templateId | 0..* | II | ||
| id | 0..* | II | ||
| sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |
| code | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| playingDevice | 0..1 | Device | ||
| playingEntity | 1..1 | PlayingEntity | ||
| classCode | 1..1 | code | Binding: EntityClassRoot (required) Required Pattern: MMAT | |
| determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| code | 1..1 | CE | Binding: Substance Reactant for Intolerance (example) | |
| quantity | 0..* | PQ | ||
| name | 0..* | EN | ||
| desc | 0..1 | ED | ||
| scopingEntity | 0..1 | Entity | ||
| Slices for entryRelationship | C | 0..* | Element | Slice: Unordered, Open by profile:observation |
| entryRelationship:allergyStatus | C | 0..1 | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | AllergyStatusObservation | Base for all types and resources | |
| entryRelationship:reaction | C | 0..* | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: MFST | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | ReactionObservation | Base for all types and resources | |
| entryRelationship:severity | C | 0..1 | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| entryRelationship:criticality | C | 0..1 | Element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Required Pattern: SUBJ | |
| inversionInd | 1..1 | boolean | Required Pattern: true | |
| contextConductionInd | 1..1 | boolean | ||
| sequenceNumber | 0..1 | INT | ||
| negationInd | 0..1 | boolean | ||
| seperatableInd | 0..1 | BL | ||
| observation | 1..1 | CriticalityObservation | Base for all types and resources | |
| reference | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | ||
| seperatableInd | 0..1 | BL | ||
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| precondition | 0..* | Precondition | ||
| referenceRange | 0..* | Element | ||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| typeCode | 1..1 | code | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
| observationRange | 1..1 | ObservationRange | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Pattern: OBS |
| Observation.templateId:primary.nullFlavor | required | NullFlavor |
| Observation.templateId:secondary.nullFlavor | required | NullFlavor |
| Observation.code | extensible | ObservationType |
| Observation.code.nullFlavor | required | NullFlavor |
| Observation.statusCode | required | ActStatus |
| Observation.statusCode.nullFlavor | required | NullFlavor |
| Observation.effectiveTime.nullFlavor | required | NullFlavor |
| Observation.priorityCode | extensible | ActPriority |
| Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Observation.value | required | Allergy and Intolerance Type |
| Observation.value.nullFlavor | required | NullFlavor |
| Observation.value.code | required | Allergy and Intolerance Type |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | extensible | ObservationMethod |
| Observation.subject.typeCode | required | Fixed Value: SBJ |
| Observation.subject.contextControlCode | required | Fixed Value: OP |
| Observation.subject.awarenessCode | extensible | TargetAwareness |
| Observation.informant.typeCode | required | Fixed Value: INF |
| Observation.informant.contextControlCode | required | Fixed Value: OP |
| Observation.participant:participant1.nullFlavor | required | NullFlavor |
| Observation.participant:participant1.typeCode | required | Pattern: CSM |
| Observation.participant:participant1.contextControlCode | required | Fixed Value: OP |
| Observation.participant:participant1.participantRole.classCode | required | Pattern: MANU |
| Observation.participant:participant1.participantRole.code | extensible | RoleCode |
| Observation.participant:participant1.participantRole.playingEntity.classCode | required | Pattern: MMAT |
| Observation.participant:participant1.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
| Observation.participant:participant1.participantRole.playingEntity.code | example | Substance Reactant for Intolerance |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| obs-er-1 | error | Observation.entryRelationship, Observation.entryRelationship:allergyStatus, Observation.entryRelationship:reaction, Observation.entryRelationship:severity, Observation.entryRelationship:criticality | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from SubstanceOrDeviceAllergyIntoleranceObservation
Summary
Mandatory: 14 elements (3 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change