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

Resource Profile: Outcome Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.144 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: OutcomeObservation
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.144

This template represents the outcome of care resulting from the interventions used to treat the patient. In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.

Often thought of as an “actual outcome”, the Outcome Observation may be related to goals, progression toward goals, and the associated interventions. For example, an observation outcome of a blood oxygen saturation level of 95% is related to the goal of “Maintain Pulse Ox greater than 92”, which in turn is related to the health concern of respiratory insufficiency and the problem of pneumonia. The template makes use of the Entry Reference (templateId:2.16.840.1.113883.10.20.22.4.122) to reference the interventions and goals defined elsewhere in the Care Plan CDA instance.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationBase for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1codeRequired Pattern: OBS
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... code 1..1CD
... value 0..1BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*ElementWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... typeCode 1..1codeRequired Pattern: GEVL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation 0..1ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... typeCode 1..1codeRequired Pattern: SPRT
..... inversionInd 1..1booleanRequired Pattern: true
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference C0..*Element1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... typeCode 1..1codeRequired Pattern: RSON
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Element
.... typeCode 1..1codeRequired Pattern: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationBase for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... code 1..1CDBinding: ObservationType (extensible)
... value 0..1
.... valueBL
.... valueED
.... valueED
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship C0..*ElementWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:entryReference C0..*ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... typeCode 1..1codeRequired Pattern: GEVL
..... contextConductionInd 1..1boolean
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation C0..1ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... typeCode 1..1codeRequired Pattern: SPRT
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference C0..*Element1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Element
.... typeCode 1..1codeRequired Pattern: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredPattern: OBS
Observation.codeextensibleObservationType

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-er-1errorObservation.entryRelationship, Observation.entryRelationship:entryReference, Observation.entryRelationship:progressTowardGoalObservation, Observation.entryRelationship:entryReferenceOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationBase for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
... moodCode 1..1codeRequired Pattern: EVN
... negationInd 0..1boolean
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
..... extension 0..1string
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
... derivationExpr 0..1ED
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 0..1
.... valueBL
.... valueED
.... valueED
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... Slices for entryRelationship C0..*ElementWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:entryReference C0..*ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: GEVL
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation C0..1ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SPRT
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference C0..*Element1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeRequired Pattern: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources
... precondition 0..*Precondition
... referenceRange 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredPattern: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.subject.typeCoderequiredFixed Value: SBJ
Observation.subject.contextControlCoderequiredFixed Value: OP
Observation.subject.awarenessCodeextensibleTargetAwareness
Observation.informant.typeCoderequiredFixed Value: INF
Observation.informant.contextControlCoderequiredFixed Value: OP
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-er-1errorObservation.entryRelationship, Observation.entryRelationship:entryReference, Observation.entryRelationship:progressTowardGoalObservation, Observation.entryRelationship:entryReferenceOnly 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: 6 elements (9 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the value of value:root
  • The element Observation.entryRelationship is sliced based on the values of profile:act, profile:observation

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationBase for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1codeRequired Pattern: OBS
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... code 1..1CD
... value 0..1BL, ED, ED, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*ElementWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... typeCode 1..1codeRequired Pattern: GEVL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation 0..1ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... typeCode 1..1codeRequired Pattern: SPRT
..... inversionInd 1..1booleanRequired Pattern: true
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference C0..*Element1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... typeCode 1..1codeRequired Pattern: RSON
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Element
.... typeCode 1..1codeRequired Pattern: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationBase for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... code 1..1CDBinding: ObservationType (extensible)
... value 0..1
.... valueBL
.... valueED
.... valueED
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship C0..*ElementWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:entryReference C0..*ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... typeCode 1..1codeRequired Pattern: GEVL
..... contextConductionInd 1..1boolean
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation C0..1ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... typeCode 1..1codeRequired Pattern: SPRT
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference C0..*Element1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Element
.... typeCode 1..1codeRequired Pattern: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredPattern: OBS
Observation.codeextensibleObservationType

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-er-1errorObservation.entryRelationship, Observation.entryRelationship:entryReference, Observation.entryRelationship:progressTowardGoalObservation, Observation.entryRelationship:entryReferenceOnly 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationBase for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
... moodCode 1..1codeRequired Pattern: EVN
... negationInd 0..1boolean
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
..... extension 0..1string
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
... derivationExpr 0..1ED
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 0..1
.... valueBL
.... valueED
.... valueED
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... Slices for entryRelationship C0..*ElementWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:entryReference C0..*ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: GEVL
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation C0..1ElementThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SPRT
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference C0..*Element1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeRequired Pattern: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources
... precondition 0..*Precondition
... referenceRange 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredPattern: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.subject.typeCoderequiredFixed Value: SBJ
Observation.subject.contextControlCoderequiredFixed Value: OP
Observation.subject.awarenessCodeextensibleTargetAwareness
Observation.informant.typeCoderequiredFixed Value: INF
Observation.informant.contextControlCoderequiredFixed Value: OP
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-er-1errorObservation.entryRelationship, Observation.entryRelationship:entryReference, Observation.entryRelationship:progressTowardGoalObservation, Observation.entryRelationship:entryReferenceOnly 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: 6 elements (9 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the value of value:root
  • The element Observation.entryRelationship is sliced based on the values of profile:act, profile:observation

 

Other representations of profile: CSV, Excel, Schematron