INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-Subscore-Observation-1

An Observation resource used to carry a subscore calculated for the observation.

The official URL for this profile is: 

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Subscore-Observation-1

Formal Views of Profile Content

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

This structure is derived from Observation

Summary

Mandatory: 2 elements (13 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.bodySite.coding is sliced based on the value of value:system
  • The element Observation.method.coding is sliced based on the value of value:system

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... identifier
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... basedOn 0..*Reference(CareConnect-CarePlan-1 | DeviceRequest | ImmunizationRecommendation | NutritionOrder | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1 | CareConnect-MedicationRequest-1)
... status 1..1codeFixed Value: final
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://hl7.org/fhir/observation-category
..... code 1..1codeFixed Value: survey
..... display 1..1stringFixed Value: Survey
... code 1..1CodeableConceptBinding: Care Connect Observation Type (extensible)
... subject 0..1Reference(Device | CareConnect-Patient-1)Who and/or what this is about.
... context 0..1Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1)
... effective[x] 1..1dateTime, Period
... performer 0..*Reference(CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)
... value[x] 1..1Quantity, CodeableConcept, string, boolean, Range, Ratio, SampledData, Attachment, time, dateTime, Period
... dataAbsentReason 0..0
... bodySite 0..0
... method
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1CodingBinding: Care Connect Observation Method (preferred)
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriFixed Value: http://snomed.info/sct
...... version 0..0
...... code 1..1code
...... display 1..1string
... specimen 0..0
... related
.... type 1..1codeFixed Value: derived-from
.... target 1..1Reference(QuestionnaireResponse | Sequence | CareConnect-Observation-1)
... component
.... code 1..1CodeableConceptBinding: Care Connect Observation Type (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CareConnect-CarePlan-1 | DeviceRequest | ImmunizationRecommendation | NutritionOrder | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1 | CareConnect-MedicationRequest-1)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: final
... category 0..*CodeableConceptClassification of type of observation.
Binding: Observation Category Codes (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: survey
..... display Σ1..1stringRepresentation defined by the system
Fixed Value: Survey
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: Care Connect Observation Type (extensible)
... subject Σ0..1Reference(Device | CareConnect-Patient-1)Who and/or what this is about.
... context 0..1Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1)Healthcare event during which this observation is made
... effective[x] Σ1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)Who is responsible for the observation
... value[x] ΣI1..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueAttachmentAttachment
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Observation Method (preferred)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related ΣI0..*BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
Fixed Value: derived-from
.... target 1..1Reference(QuestionnaireResponse | Sequence | CareConnect-Observation-1)Resource that is related to this one
... component ΣI0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: Care Connect Observation Type (extensible)
.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueAttachmentAttachment
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 2 elements (13 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.bodySite.coding is sliced based on the value of value:system
  • The element Observation.method.coding is sliced based on the value of value:system

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... identifier
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... basedOn 0..*Reference(CareConnect-CarePlan-1 | DeviceRequest | ImmunizationRecommendation | NutritionOrder | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1 | CareConnect-MedicationRequest-1)
... status 1..1codeFixed Value: final
.... coding 1..1Coding
..... system 1..1uriFixed Value: http://hl7.org/fhir/observation-category
..... code 1..1codeFixed Value: survey
..... display 1..1stringFixed Value: Survey
... code 1..1CodeableConceptBinding: Care Connect Observation Type (extensible)
... subject 0..1Reference(Device | CareConnect-Patient-1)Who and/or what this is about.
... context 0..1Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1)
... effective[x] 1..1dateTime, Period
... performer 0..*Reference(CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)
... value[x] 1..1Quantity, CodeableConcept, string, boolean, Range, Ratio, SampledData, Attachment, time, dateTime, Period
... dataAbsentReason 0..0
... bodySite 0..0
... method
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1CodingBinding: Care Connect Observation Method (preferred)
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriFixed Value: http://snomed.info/sct
...... version 0..0
...... code 1..1code
...... display 1..1string
... specimen 0..0
... related
.... type 1..1codeFixed Value: derived-from
.... target 1..1Reference(QuestionnaireResponse | Sequence | CareConnect-Observation-1)
... component
.... code 1..1CodeableConceptBinding: Care Connect Observation Type (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CareConnect-CarePlan-1 | DeviceRequest | ImmunizationRecommendation | NutritionOrder | CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1 | CareConnect-MedicationRequest-1)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
Fixed Value: final
... category 0..*CodeableConceptClassification of type of observation.
Binding: Observation Category Codes (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: survey
..... display Σ1..1stringRepresentation defined by the system
Fixed Value: Survey
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: Care Connect Observation Type (extensible)
... subject Σ0..1Reference(Device | CareConnect-Patient-1)Who and/or what this is about.
... context 0..1Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1)Healthcare event during which this observation is made
... effective[x] Σ1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(CareConnect-RelatedPerson-1 | CareConnect-Patient-1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)Who is responsible for the observation
... value[x] ΣI1..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueAttachmentAttachment
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Observation Method (preferred)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: Observation Reference Range Meaning Codes (extensible)
.... appliesTo 0..*CodeableConceptReference range population
Binding: Observation Reference Range Applies To Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related ΣI0..*BackboneElementResource related to this observation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
Fixed Value: derived-from
.... target 1..1Reference(QuestionnaireResponse | Sequence | CareConnect-Observation-1)Resource that is related to this one
... component ΣI0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: Care Connect Observation Type (extensible)
.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueAttachmentAttachment
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Observation.languageextensibleCommon Languages
Max Binding: All Languages
Observation.identifier.userequiredIdentifierUse
Observation.identifier.typeextensibleIdentifier Type Codes
Observation.statusrequiredFixed Value: final
Observation.categoryrequiredObservation Category Codes
Observation.codeextensibleCare Connect Observation Type
Observation.interpretationextensibleObservation Interpretation Codes
Observation.methodexampleObservation Methods
Observation.method.coding:snomedCTpreferredCare Connect Observation Method
Observation.referenceRange.typeextensibleObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToexampleObservation Reference Range Applies To Codes
Observation.related.typerequiredFixed Value: derived-from
Observation.component.codeextensibleCare Connect Observation Type
Observation.component.dataAbsentReasonextensibleObservation Value Absent Reason
Observation.component.interpretationextensibleObservation Interpretation Codes

Constraints

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
ele-1Observation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1Observation.relatedAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Observation.componentAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())