International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPS Planned Observation

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.41--20200508183442 Version: 1.0
Draft as of 2020-05-08 Computable Name: IPSPlannedObservation
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.41 (use: OFFICIAL)

The observation request entry is used to record goals, plans or intention for an observation to be performed (e.g., assessment, laboratory test, imaging study, et cetera.html).

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 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeFixed Value: OBS
... moodCode 1..1codeRequired Pattern: GOL
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.41
... code S1..1CD
... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CS
... effectiveTime S0..1IVL_TS
... value 0..*BL, 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
... methodCode 0..*CE
... targetSiteCode 0..*CD
... author 0..*Author

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeRequired Pattern: GOL
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.41
... code S1..1CDBinding: ObservationType (extensible)
... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CSBinding: ActStatus (required)
... effectiveTime S0..1IVL_TS
... value 0..*
.... 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
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... author 0..*Author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.methodCodeextensibleObservationMethod
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeRequired Pattern: GOL
... negationInd 0..1boolean
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.41
..... extension 0..1string
... id S0..*II
... code S1..1CDBinding: ObservationType (extensible)
... derivationExpr 0..1ED
... text S0..1ED
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... compression 0..1codeBinding: CompressionAlgorithm (required)
.... integrityCheck 0..1base64Binary
.... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
.... language 0..1code
.... mediaType 0..1code
.... representation 0..1code
.... data[x] 0..1
..... dataStringstring
..... dataBase64Binarybase64Binary
.... reference S1..1TEL
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... value 1..1uri
..... useablePeriod 0..*
...... useablePeriodIVL_TS
...... useablePeriodEIVL_TS
...... useablePeriodPIVL_TS
...... useablePeriodSXPR_TS
..... use 0..*codeBinding: AddressUse (required)
.... thumbnail 0..1ED
... statusCode S1..1CSBinding: ActStatus (required)
... effectiveTime S0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 0..*
.... 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..1idUnique 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..*Author
... informant 0..*Element
.... id 0..1idUnique 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
... entryRelationship C0..*Element
.... id 0..1idUnique 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
... reference 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition
... referenceRange 0..*Element
.... id 0..1idUnique 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.classCoderequiredFixed Value: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.text.nullFlavorrequiredNullFlavor
Observation.text.compressionrequiredCompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.reference.nullFlavorrequiredNullFlavor
Observation.text.reference.userequiredAddressUse
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
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.entryRelationshipOnly 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 (2 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeFixed Value: OBS
... moodCode 1..1codeRequired Pattern: GOL
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.41
... code S1..1CD
... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CS
... effectiveTime S0..1IVL_TS
... value 0..*BL, 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
... methodCode 0..*CE
... targetSiteCode 0..*CD
... author 0..*Author

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeRequired Pattern: GOL
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.41
... code S1..1CDBinding: ObservationType (extensible)
... text S0..1ED
.... reference S1..1TEL
..... value 1..1uri
... statusCode S1..1CSBinding: ActStatus (required)
... effectiveTime S0..1IVL_TS
... value 0..*
.... 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
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... author 0..*Author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.methodCodeextensibleObservationMethod

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*CDAR2.ObservationBase for all types and resources
... classCode 1..1codeBinding: ActClassObservation (required)
Fixed Value: OBS
... moodCode 1..1codeRequired Pattern: GOL
... negationInd 0..1boolean
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.41
..... extension 0..1string
... id S0..*II
... code S1..1CDBinding: ObservationType (extensible)
... derivationExpr 0..1ED
... text S0..1ED
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... compression 0..1codeBinding: CompressionAlgorithm (required)
.... integrityCheck 0..1base64Binary
.... integrityCheckAlgorithm 0..1codeBinding: IntegrityCheckAlgorithm (required)
.... language 0..1code
.... mediaType 0..1code
.... representation 0..1code
.... data[x] 0..1
..... dataStringstring
..... dataBase64Binarybase64Binary
.... reference S1..1TEL
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... value 1..1uri
..... useablePeriod 0..*
...... useablePeriodIVL_TS
...... useablePeriodEIVL_TS
...... useablePeriodPIVL_TS
...... useablePeriodSXPR_TS
..... use 0..*codeBinding: AddressUse (required)
.... thumbnail 0..1ED
... statusCode S1..1CSBinding: ActStatus (required)
... effectiveTime S0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 0..*
.... 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..1idUnique 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..*Author
... informant 0..*Element
.... id 0..1idUnique 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
... entryRelationship C0..*Element
.... id 0..1idUnique 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
... reference 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition
... referenceRange 0..*Element
.... id 0..1idUnique 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.classCoderequiredFixed Value: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.text.nullFlavorrequiredNullFlavor
Observation.text.compressionrequiredCompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.reference.nullFlavorrequiredNullFlavor
Observation.text.reference.userequiredAddressUse
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
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.entryRelationshipOnly 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 (2 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel, Schematron