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.68 | Version: 2.1.0-draft1 | |||
Draft as of 2023-01-16 | Computable Name: FunctionalStatusProblemObservation | |||
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.68:2014-06-09 |
A functional status problem observation is a clinical statement that represents a patient’s functional perfomance and ability.
THIS TEMPLATE HAS BEEN DEPRECATED IN C-CDA R2 AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED.
Reason for deprecation: Functional Status Problem Observation has been merged, without loss of expressivity, into Functional Status Observation (2.16.840.1.113883.10.20.22.4.67:2014-06-09).
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 | 1..1 | CDAR2.Observation | 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 problem 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.22.4.68 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
code | 0..1 | string | Required Pattern: 248536006 | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
value | C | 0..1 | uri | 1098-15554: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
effectiveTime | 0..1 | IVL_TS | ||
low | 1..1 | TS | The value of effectiveTime/low represents onset date. | |
high | 0..1 | TS | If the problem is resolved, record the resolution date in effectiveTime/high. If the problem is known to be resolved but the resolution date is not known, use @nullFlavor="UNK". If the problem is not resolved, do not include the high element. | |
value | 1..1 | CD | Binding: Problem (preferred) | |
nullFlavor | C | 0..1 | code | 1098-14293: If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). |
methodCode | 0..1 | CE | ||
Documentation for this format |
Path | Conformance | ValueSet |
Observation.value | preferred | Problem |
Id | Grade | Path(s) | Details | Requirements |
1098-14293 | warning | Observation.value.nullFlavor | If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). : | |
1098-15554 | error | Observation.text.reference.value | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | 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 problem 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.22.4.68 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: ObservationType (extensible) | |
code | 0..1 | string | Required Pattern: 248536006 | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
value | C | 0..1 | uri | 1098-15554: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: completed | |
effectiveTime | 0..1 | IVL_TS | ||
low | 1..1 | TS | The value of effectiveTime/low represents onset date. | |
high | 0..1 | TS | If the problem is resolved, record the resolution date in effectiveTime/high. If the problem is known to be resolved but the resolution date is not known, use @nullFlavor="UNK". If the problem is not resolved, do not include the high element. | |
value | 1..1 | CD | Binding: Problem (preferred) | |
nullFlavor | C | 0..1 | code | Binding: NullFlavor (required) 1098-14293: If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). |
methodCode | 0..1 | CE | Binding: ObservationMethod (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: OBS |
Observation.code | extensible | ObservationType |
Observation.statusCode | required | ActStatus |
Observation.value | preferred | Problem |
Observation.value.nullFlavor | required | NullFlavor |
Observation.methodCode | extensible | ObservationMethod |
Id | Grade | Path(s) | Details | Requirements |
1098-14293 | warning | Observation.value.nullFlavor | If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). : | |
1098-15554 | error | Observation.text.reference.value | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | 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 problem 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.22.4.68 | |
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 | 0..1 | string | Required Pattern: 248536006 | |
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 | ||
derivationExpr | 0..1 | ED | ||
text | 0..1 | ED | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
charset | 0..1 | code | ||
compression | 0..1 | code | Binding: CompressionAlgorithm (required) | |
integrityCheck | 0..1 | base64Binary | ||
integrityCheckAlgorithm | 0..1 | code | Binding: IntegrityCheckAlgorithm (required) | |
language | 0..1 | code | ||
mediaType | 0..1 | code | ||
representation | 0..1 | code | ||
data[x] | 0..1 | |||
dataString | string | |||
dataBase64Binary | base64Binary | |||
reference | 0..1 | TEL | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
value | C | 0..1 | uri | 1098-15554: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). |
useablePeriod | 0..* | |||
useablePeriod | IVL_TS | |||
useablePeriod | EIVL_TS | |||
useablePeriod | PIVL_TS | |||
useablePeriod | SXPR_TS | |||
use | 0..* | code | Binding: AddressUse (required) | |
thumbnail | 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 | 0..1 | IVL_TS | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
value | 0..1 | dateTime | ||
inclusive | 0..1 | boolean | ||
operator | 0..1 | code | ||
low | 1..1 | TS | The value of effectiveTime/low represents onset date. | |
high | 0..1 | TS | If the problem is resolved, record the resolution date in effectiveTime/high. If the problem is known to be resolved but the resolution date is not known, use @nullFlavor="UNK". If the problem is not resolved, do not include the high element. | |
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 | Binding: Problem (preferred) | |
nullFlavor | C | 0..1 | code | Binding: NullFlavor (required) 1098-14293: If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). |
code | 0..1 | string | ||
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..1 | 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..* | Author | ||
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 | ||
participant | 0..* | Participant2 | ||
entryRelationship | 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 | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
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.code | extensible | ObservationType |
Observation.code.nullFlavor | required | NullFlavor |
Observation.text.nullFlavor | required | NullFlavor |
Observation.text.compression | required | CompressionAlgorithm |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Observation.text.reference.nullFlavor | required | NullFlavor |
Observation.text.reference.use | required | AddressUse |
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 | preferred | Problem |
Observation.value.nullFlavor | required | NullFlavor |
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.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
1098-14293 | warning | Observation.value.nullFlavor | If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). : | |
1098-15554 | error | Observation.text.reference.value | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). : | |
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 | 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 CDAR2.Observation
Summary
Mandatory: 10 elements (1 nested mandatory element)
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | 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 problem 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.22.4.68 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | ||
code | 0..1 | string | Required Pattern: 248536006 | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
value | C | 0..1 | uri | 1098-15554: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
effectiveTime | 0..1 | IVL_TS | ||
low | 1..1 | TS | The value of effectiveTime/low represents onset date. | |
high | 0..1 | TS | If the problem is resolved, record the resolution date in effectiveTime/high. If the problem is known to be resolved but the resolution date is not known, use @nullFlavor="UNK". If the problem is not resolved, do not include the high element. | |
value | 1..1 | CD | Binding: Problem (preferred) | |
nullFlavor | C | 0..1 | code | 1098-14293: If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). |
methodCode | 0..1 | CE | ||
Documentation for this format |
Path | Conformance | ValueSet |
Observation.value | preferred | Problem |
Id | Grade | Path(s) | Details | Requirements |
1098-14293 | warning | Observation.value.nullFlavor | If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). : | |
1098-15554 | error | Observation.text.reference.value | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | 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 problem 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.22.4.68 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 1..1 | CD | Binding: ObservationType (extensible) | |
code | 0..1 | string | Required Pattern: 248536006 | |
text | 0..1 | ED | ||
reference | 0..1 | TEL | ||
value | C | 0..1 | uri | 1098-15554: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: completed | |
effectiveTime | 0..1 | IVL_TS | ||
low | 1..1 | TS | The value of effectiveTime/low represents onset date. | |
high | 0..1 | TS | If the problem is resolved, record the resolution date in effectiveTime/high. If the problem is known to be resolved but the resolution date is not known, use @nullFlavor="UNK". If the problem is not resolved, do not include the high element. | |
value | 1..1 | CD | Binding: Problem (preferred) | |
nullFlavor | C | 0..1 | code | Binding: NullFlavor (required) 1098-14293: If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). |
methodCode | 0..1 | CE | Binding: ObservationMethod (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.classCode | required | Pattern: OBS |
Observation.code | extensible | ObservationType |
Observation.statusCode | required | ActStatus |
Observation.value | preferred | Problem |
Observation.value.nullFlavor | required | NullFlavor |
Observation.methodCode | extensible | ObservationMethod |
Id | Grade | Path(s) | Details | Requirements |
1098-14293 | warning | Observation.value.nullFlavor | If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). : | |
1098-15554 | error | Observation.text.reference.value | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 1..1 | CDAR2.Observation | 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 problem 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.22.4.68 | |
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 | 0..1 | string | Required Pattern: 248536006 | |
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 | ||
derivationExpr | 0..1 | ED | ||
text | 0..1 | ED | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
charset | 0..1 | code | ||
compression | 0..1 | code | Binding: CompressionAlgorithm (required) | |
integrityCheck | 0..1 | base64Binary | ||
integrityCheckAlgorithm | 0..1 | code | Binding: IntegrityCheckAlgorithm (required) | |
language | 0..1 | code | ||
mediaType | 0..1 | code | ||
representation | 0..1 | code | ||
data[x] | 0..1 | |||
dataString | string | |||
dataBase64Binary | base64Binary | |||
reference | 0..1 | TEL | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
value | C | 0..1 | uri | 1098-15554: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). |
useablePeriod | 0..* | |||
useablePeriod | IVL_TS | |||
useablePeriod | EIVL_TS | |||
useablePeriod | PIVL_TS | |||
useablePeriod | SXPR_TS | |||
use | 0..* | code | Binding: AddressUse (required) | |
thumbnail | 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 | 0..1 | IVL_TS | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
value | 0..1 | dateTime | ||
inclusive | 0..1 | boolean | ||
operator | 0..1 | code | ||
low | 1..1 | TS | The value of effectiveTime/low represents onset date. | |
high | 0..1 | TS | If the problem is resolved, record the resolution date in effectiveTime/high. If the problem is known to be resolved but the resolution date is not known, use @nullFlavor="UNK". If the problem is not resolved, do not include the high element. | |
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 | Binding: Problem (preferred) | |
nullFlavor | C | 0..1 | code | Binding: NullFlavor (required) 1098-14293: If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). |
code | 0..1 | string | ||
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..1 | 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..* | Author | ||
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 | ||
participant | 0..* | Participant2 | ||
entryRelationship | 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 | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
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.code | extensible | ObservationType |
Observation.code.nullFlavor | required | NullFlavor |
Observation.text.nullFlavor | required | NullFlavor |
Observation.text.compression | required | CompressionAlgorithm |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Observation.text.reference.nullFlavor | required | NullFlavor |
Observation.text.reference.use | required | AddressUse |
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 | preferred | Problem |
Observation.value.nullFlavor | required | NullFlavor |
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.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
1098-14293 | warning | Observation.value.nullFlavor | If the diagnosis is unknown or the SNOMED code is unknown, @nullFlavor SHOULD be “UNK”. If the diagnosis is known but the code cannot be found in the Value Set, @nullFlavor SHOULD be “OTH” and the known diagnosis code SHOULD be placed in the translation element (CONF:1098-14293). : | |
1098-15554 | error | Observation.text.reference.value | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1098-15554). : | |
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 | 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 CDAR2.Observation
Summary
Mandatory: 10 elements (1 nested mandatory element)
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron