Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ReactionObservation | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: ReactionObservation | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09 | ||||
This clinical statement represents the response to an undesired symptom, finding, etc. due to administered or exposed substance. A reaction can be defined described with respect to its severity, and can have been treated by one or more interventions.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange | ||
 classCode | 1..1 | cs | Fixed Value: OBS | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.9 | |
  extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | cs | Required Pattern: ASSERTION | |
 codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Fixed Value: completed | |
| effectiveTime | 0..1 | IVL_TS | ||
| low | 0..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
 value | 1..1 | CD | Binding: Problem (required) | |
 Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:procedure, profile:substanceAdministration, profile:observation | |
 entryRelationship:procedure | 0..* | EntryRelationship | ||
 typeCode | 1..1 | cs | Fixed Value: RSON | |
| inversionInd | 1..1 | bl | Fixed Value: true | |
| procedure | 1..1 | ProcedureActivityProcedure | This procedure activity is intended to contain information about procedures that were performed in response to an allergy reaction. | |
| entryRelationship:medication | 0..* | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: RSON | |
| inversionInd | 1..1 | bl | Fixed Value: true | |
| substanceAdministration | 1..1 | MedicationActivity | This medication activity is intended to contain information about medications that were administered in response to an allergy reaction. | |
| entryRelationship:severity | 0..1 | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value | required | Problem |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
 @classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.9 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| @code | 1..1 | cs | Required Pattern: ASSERTION | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| effectiveTime | 0..1 | IVL_TS | ||
| low | 0..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| value | 1..1 | CD | Binding: Problem (required) | |
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:procedure, profile:substanceAdministration, profile:observation | |
| entryRelationship:procedure | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| procedure | 1..1 | ProcedureActivityProcedure | This procedure activity is intended to contain information about procedures that were performed in response to an allergy reaction. | |
| entryRelationship:medication | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| substanceAdministration | C | 1..1 | MedicationActivity | This medication activity is intended to contain information about medications that were administered in response to an allergy reaction. |
| entryRelationship:severity | 0..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.value | required | Problem |
| Observation.entryRelationship:procedure.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:medication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:severity.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-30800 | warning | Observation.entryRelationship:medication.substanceAdministration | Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.templateId:primary.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.effectiveTime.operator | required | SetOperator |
| Observation.priorityCode | extensible | ActPriority |
| Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Observation.value | required | Problem |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | extensible | ObservationMethod |
| Observation.entryRelationship:procedure.nullFlavor | required | NullFlavor |
| Observation.entryRelationship:procedure.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:medication.nullFlavor | required | NullFlavor |
| Observation.entryRelationship:medication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:severity.nullFlavor | required | NullFlavor |
| Observation.entryRelationship:severity.typeCode | required | Fixed Value: SUBJ |
| Observation.referenceRange.nullFlavor | required | NullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-30800 | warning | Observation.entryRelationship:medication.substanceAdministration | Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 10 elements (6 nested mandatory elements)
Fixed Value: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange | ||
| classCode | 1..1 | cs | Fixed Value: OBS | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.9 | |
| extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| code | 1..1 | cs | Required Pattern: ASSERTION | |
| codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Fixed Value: completed | |
| effectiveTime | 0..1 | IVL_TS | ||
| low | 0..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| value | 1..1 | CD | Binding: Problem (required) | |
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:procedure, profile:substanceAdministration, profile:observation | |
| entryRelationship:procedure | 0..* | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: RSON | |
| inversionInd | 1..1 | bl | Fixed Value: true | |
| procedure | 1..1 | ProcedureActivityProcedure | This procedure activity is intended to contain information about procedures that were performed in response to an allergy reaction. | |
| entryRelationship:medication | 0..* | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: RSON | |
| inversionInd | 1..1 | bl | Fixed Value: true | |
| substanceAdministration | 1..1 | MedicationActivity | This medication activity is intended to contain information about medications that were administered in response to an allergy reaction. | |
| entryRelationship:severity | 0..1 | EntryRelationship | ||
| typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.value | required | Problem |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.9 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| @code | 1..1 | cs | Required Pattern: ASSERTION | |
| @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| effectiveTime | 0..1 | IVL_TS | ||
| low | 0..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
| value | 1..1 | CD | Binding: Problem (required) | |
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:procedure, profile:substanceAdministration, profile:observation | |
| entryRelationship:procedure | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| procedure | 1..1 | ProcedureActivityProcedure | This procedure activity is intended to contain information about procedures that were performed in response to an allergy reaction. | |
| entryRelationship:medication | 0..* | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| substanceAdministration | C | 1..1 | MedicationActivity | This medication activity is intended to contain information about medications that were administered in response to an allergy reaction. |
| entryRelationship:severity | 0..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | SeverityObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.value | required | Problem |
| Observation.entryRelationship:procedure.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:medication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:severity.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-30800 | warning | Observation.entryRelationship:medication.substanceAdministration | Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.templateId:primary.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.effectiveTime.operator | required | SetOperator |
| Observation.priorityCode | extensible | ActPriority |
| Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Observation.value | required | Problem |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | extensible | ObservationMethod |
| Observation.entryRelationship:procedure.nullFlavor | required | NullFlavor |
| Observation.entryRelationship:procedure.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:medication.nullFlavor | required | NullFlavor |
| Observation.entryRelationship:medication.typeCode | required | Fixed Value: RSON |
| Observation.entryRelationship:severity.nullFlavor | required | NullFlavor |
| Observation.entryRelationship:severity.typeCode | required | Fixed Value: SUBJ |
| Observation.referenceRange.nullFlavor | required | NullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-30800 | warning | Observation.entryRelationship:medication.substanceAdministration | Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 10 elements (6 nested mandatory elements)
Fixed Value: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change