Left: | Allergy - Intolerance Observation (http://hl7.org/cda/us/ccda/StructureDefinition/AllergyIntoleranceObservation) |
Right: | Allergy - Intolerance Observation (http://hl7.org/cda/us/ccda/StructureDefinition/AllergyIntoleranceObservation) |
Error | StructureDefinition.version | Values for version differ: '3.0.0' vs '4.0.0' |
Information | StructureDefinition.date | Values for date differ: '2024-05-18T00:16:25-05:00' vs '2024-10-19T22:19:38+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation | ||
copyright | |||
date | 2024-05-18T00:16:25-05:00 | 2024-10-19T22:19:38+00:00 |
|
description | 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. | ||
experimental | |||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | logical | ||
name | AllergyIntoleranceObservation | ||
publisher | Health Level Seven | ||
purpose | |||
status | draft | ||
title | Allergy - Intolerance Observation | ||
type | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
url | http://hl7.org/cda/us/ccda/StructureDefinition/AllergyIntoleranceObservation | ||
version | 3.0.0 | 4.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments |
---|---|---|---|---|---|---|---|---|---|
Observation | C | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-author: SHOULD contain author should-not-severity: Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. | C | 1..1 | SubstanceOrDeviceAllergyIntoleranceObservation | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-author: SHOULD contain author should-not-severity: Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. | |
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
Slices for templateId | 2..* | II | Slice: Unordered, Open by value:root, value:extension | 2..* | II | Slice: Unordered, Open by value:root, value:extension | |||
classCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: OBS | 1..1 | ?? | Binding: ?? (required) Fixed Value: OBS | |||
moodCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: EVN | 1..1 | ?? | Binding: ?? (required) Fixed Value: EVN | |||
negationInd | 0..1 | ?? | Use negationInd="true" to indicate that the allergy was not observed. | 0..1 | ?? | Use negationInd="true" to indicate that the allergy was not observed. | |||
id | 1..* | II | 1..* | II | |||||
code | 1..1 | CD | Binding: ?? (example) | 1..1 | CD | Binding: ?? (example) | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
code | 1..1 | ?? | Required Pattern: ASSERTION | 1..1 | ?? | Required Pattern: ASSERTION | |||
codeSystem | 1..1 | ??, ??, ?? | Required Pattern: 2.16.840.1.113883.5.4 | 1..1 | ??, ??, ?? | Required Pattern: 2.16.840.1.113883.5.4 | |||
codeSystemName | 0..1 | ?? | 0..1 | ?? | |||||
codeSystemVersion | 0..1 | ?? | 0..1 | ?? | |||||
displayName | 0..1 | ?? | 0..1 | ?? | |||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..1 | ED | 0..1 | ED | |||||
qualifier | 0..* | CR | 0..* | CR | |||||
translation | 0..* | CD | 0..* | CD | |||||
derivationExpr | 0..1 | ST | 0..1 | ST | |||||
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
compression | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
integrityCheck | 0..1 | ?? | 0..1 | ?? | |||||
integrityCheckAlgorithm | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
language | 0..1 | ?? | 0..1 | ?? | |||||
mediaType | 0..1 | ?? | Binding: ?? (example) | 0..1 | ?? | Binding: ?? (example) | |||
representation | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
xmlText | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |||
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | |
thumbnail | 0..1 | ED | 0..1 | ED | |||||
statusCode | 1..1 | CS | Binding: ?? (required) | 1..1 | CS | Binding: ?? (required) | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
code | 1..1 | ?? | Fixed Value: completed | 1..1 | ?? | Fixed Value: completed | |||
codeSystem | 0..0 | 0..0 | |||||||
codeSystemName | 0..0 | 0..0 | |||||||
codeSystemVersion | 0..0 | 0..0 | |||||||
displayName | 0..0 | 0..0 | |||||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..0 | 0..0 | |||||||
qualifier | 0..0 | 0..0 | |||||||
translation | 0..0 | 0..0 | |||||||
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'. | 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 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
value | 0..1 | ?? | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | 0..1 | ?? | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |||
operator | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
low | 1..1 | IVXB_TS | 1..1 | IVXB_TS | |||||
center | 0..1 | TS | 0..1 | TS | |||||
width | 0..1 | PQ | 0..1 | PQ | |||||
high | 0..1 | IVXB_TS | 0..1 | IVXB_TS | |||||
priorityCode | 0..1 | CE | Binding: ?? (example) | 0..1 | CE | Binding: ?? (example) | |||
repeatNumber | 0..1 | IVL_INT | 0..1 | IVL_INT | |||||
languageCode | 0..1 | CS | Binding: ?? (required) | 0..1 | CS | Binding: ?? (required) | |||
value | 1..1 | CD | 1..1 | CD | |||||
nullFlavor | 0..0 | 0..0 | |||||||
code | 1..1 | ?? | Binding: ?? (required) | 1..1 | ?? | Binding: ?? (required) | |||
codeSystem | 0..1 | ??, ??, ?? | 0..1 | ??, ??, ?? | |||||
codeSystemName | 0..1 | ?? | 0..1 | ?? | |||||
codeSystemVersion | 0..1 | ?? | 0..1 | ?? | |||||
displayName | 0..1 | ?? | 0..1 | ?? | |||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..1 | ED | 0..1 | ED | |||||
qualifier | 0..* | CR | 0..* | CR | |||||
translation | 0..* | CD | 0..* | CD | |||||
interpretationCode | 0..* | CE | Binding: ?? (required) | 0..* | CE | Binding: ?? (required) | |||
methodCode | 0..* | CE | Binding: ?? (example) | 0..* | CE | Binding: ?? (example) | |||
targetSiteCode | 0..* | CD | 0..* | CD | |||||
subject | 0..1 | Subject | 0..1 | Subject | |||||
specimen | 0..* | Specimen | 0..* | Specimen | |||||
performer | 0..* | Performer2 | 0..* | Performer2 | |||||
author | 0..* | ?? | Base for all types and resources | 0..* | ?? | Base for all types and resources | |||
informant | 0..* | Informant | 0..* | Informant | |||||
Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |||
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:observation | 0..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |||
reference | 0..* | Reference | 0..* | Reference | |||||
precondition | 0..* | Precondition | 0..* | Precondition | |||||
sdtcPrecondition2 | 0..* | Precondition2 | XML: precondition2 (urn:hl7-org:sdtc) | 0..* | Precondition2 | XML: precondition2 (urn:hl7-org:sdtc) | |||
referenceRange | 0..* | InfrastructureRoot | 0..* | InfrastructureRoot | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
templateId | 0..* | II | 0..* | II | |||||
typeCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: REFV | 0..1 | ?? | Binding: ?? (required) Fixed Value: REFV | |||
observationRange | 1..1 | ObservationRange | 1..1 | ObservationRange | |||||
sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |||
Documentation for this format |