1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ObservationNews2Lite

Official URL: https://fhir.cambio.se/StructureDefinition/ObservationNews2Lite/v1 Version: 1.1.0
Active as of 2022-09-09 Computable Name: ObservationNews2Lite

Introduction

The ObservationNews2Lite profile represents the Assessment scale NEWS2 and is a profile created from the resource Observation. The NEWS2 is a scale for the severity of a patients condition. The NEWS2 score is calculated by the vital signs of a patient.

Intended Use

The ObservationNews2Lite is used for communicating the severity of a patients condition by sending the calculated score in observation.value. The score should be between 0 and 20. The News2 profile should also contain references for all vital signs used to calculate the score. It is mandatory to send all the vital signs. The score(observation.value) is optional. In COSMIC the NEWS2 score is mapped to the internal archetype for NEWS2.

The API can be used to create, invalidate/remove and read patient NEWS2 information from/to COSMIC.

Create NEWS2

  • To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
  • The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Invalidate NEWS2

  • If the external system is considered the master system of the information, it should be possible through the API to invalidate/delete the data in COSMIC, if it is invalidated/deleted in the master system.
  • Invalidation of data should be done by a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified unit. The Unit should also be specified with a HSA ID. This is for traceability purposes and should be for the log.

Read NEWS2

  • The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.

Specific Rules and Limitations

Type Description
Rule For creating NEWS2 data the external user must not be the patient. E.g. A healthcare professional is the intended user to create vital sign data with this API.
Rule All vital signs stated as target types in observation.derivedFrom must be referenced or included in query. One vital sign entry must only be referenced once in the same query.
Rule It should not be possible for the patient to invalidate/delete the NEWS2 after sending it to COSMIC. If this happens, it should be managed manually outside the API.
Rule For reading NEWS2 data the external user should not be someone else than the patient of which NEWS2 belongs. E.g. A healthcare professional is not the intended user of the read vital sign data with this API.
Rule This API should not be used to transfer data between caregivers.
Rule All vital signs stated as target types in element observation.derivedFrom must be included.
Rule The same vital sign profile must not be referenced more than once.

Versions

COS version Profile version Required COSMIC version Date Description
3.0.0 1.1.0 R8.3.05 May 2022 Updates in target profile for performer.organization which makes it possible to retrieve PDL units
< 3.0.0 1.0.0 R8.2.08 Feb 2021 Initial version, support for GET and POST.

Supported Operations

HTTP Method Description
GET Used to get or search for NEWS2 entries
POST Used to create an NEWS2 entry. If successful, the operation will return id in response, can also be used for invalidate

Query Operations

Parameter Format Mandatory Comment  
patient reference Yes The subject that the observation is about (if patient). The reference can be a literal reference ex: subject=1 or a Business identifier as well.ex: subject.identifier=urn:oid:1.2.752.129.2.1.3.1 20200109-6078
date date (ddmmyy) Yes Obtained date/time. The date is always a range, i.e. two dates are used as search parameters.  
status token No The status of the observation. See supported statuses in #Statuses  
_profile string No search by the profile url  

Supported Queries

  1. GET [baseURL]/Observation/_search?patient= (search)
  2. GET [baseURL]/Observation/_search?status= (search)
  3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (search)
  4. GET [baseURL]/Observation/_search?_profile= (search)
  5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (search)
  6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (search)
  7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[]
  8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[]
  9. POST [baseURL]/Observation

Supported _include params

Observation:performer Observation.derivedFrom

Error Codes

In the table below, a few error messages specific for observations are listed.

Code Description Comment
400 Subject and Performer Patient references does not match.  
400 The date time: < date > is invalid the dateTime must contain a time component
400 Server supports only final status when posting Observations Statuses preliminary, entered-in-error, cancelled are not supported when posting a NEWS2.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationNews2Core Measurements and simple assertions
Constraints: obs-6, obs-7
... meta Σ 1..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
... effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for observation
... Slices for performer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for the observation
Slice: Unordered, Open by type:$this
.... performer:organization Σ 0..1 Reference(OrganizationSEVendorLite) Who is responsible for the observation
.... performer:practitionerRole Σ 0..1 Reference(PractitionerRoleLiteSe) Who is responsible for the observation
.... performer:practitioner Σ 0..1 Reference(Practitioner) Who is responsible for the observation
... note 0..1 Annotation Comments about the observation
... derivedFrom Σ 6..6 Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredVitalSignStatus
https://cambio.codes/fhir/vs/vital-sign-status/v1
From this IG
Observation.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.component.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
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-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from ObservationNews2Core

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* ObservationNews2Core Measurements and simple assertions
... meta 1..1 Meta Metadata about the resource
.... source S 0..1 uri Identifies where the resource comes from
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... basedOn 0..0
... status 1..1 code preliminary | final | entered-in-error | cancelled
Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.
... Slices for performer 1..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for the observation
Slice: Unordered, Open by type:$this
.... performer:organization 0..1 Reference(OrganizationSEVendorLite) Who is responsible for the observation
.... performer:practitionerRole 0..1 Reference(PractitionerRoleLiteSe) Who is responsible for the observation
.... performer:practitioner 0..1 Reference(Practitioner) Who is responsible for the observation
... dataAbsentReason 0..0
... interpretation 0..0
... note 0..1 Annotation Comments about the observation
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 6..6 Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.statusrequiredVitalSignStatus
https://cambio.codes/fhir/vs/vital-sign-status/v1
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationNews2Core Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code preliminary | final | entered-in-error | cancelled
Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 1104051000000101
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for observation
... Slices for performer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for the observation
Slice: Unordered, Open by type:$this
.... performer:organization Σ 0..1 Reference(OrganizationSEVendorLite) Who is responsible for the observation
.... performer:practitionerRole Σ 0..1 Reference(PractitionerRoleLiteSe) Who is responsible for the observation
.... performer:practitioner Σ 0..1 Reference(Practitioner) Who is responsible for the observation
... value[x] ΣC 0..1 Quantity Actual result
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit
... note 0..1 Annotation Comments about the observation
... derivedFrom Σ 6..6 Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Observation.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Observation.statusrequiredVitalSignStatus
https://cambio.codes/fhir/vs/vital-sign-status/v1
From this IG
Observation.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
From the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
From the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
From the FHIR Standard
Observation.component.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
From the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
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-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationNews2Core Measurements and simple assertions
Constraints: obs-6, obs-7
... meta Σ 1..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
... effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for observation
... Slices for performer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for the observation
Slice: Unordered, Open by type:$this
.... performer:organization Σ 0..1 Reference(OrganizationSEVendorLite) Who is responsible for the observation
.... performer:practitionerRole Σ 0..1 Reference(PractitionerRoleLiteSe) Who is responsible for the observation
.... performer:practitioner Σ 0..1 Reference(Practitioner) Who is responsible for the observation
... note 0..1 Annotation Comments about the observation
... derivedFrom Σ 6..6 Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredVitalSignStatus
https://cambio.codes/fhir/vs/vital-sign-status/v1
From this IG
Observation.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.component.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
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-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from ObservationNews2Core

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* ObservationNews2Core Measurements and simple assertions
... meta 1..1 Meta Metadata about the resource
.... source S 0..1 uri Identifies where the resource comes from
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... basedOn 0..0
... status 1..1 code preliminary | final | entered-in-error | cancelled
Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.
... Slices for performer 1..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for the observation
Slice: Unordered, Open by type:$this
.... performer:organization 0..1 Reference(OrganizationSEVendorLite) Who is responsible for the observation
.... performer:practitionerRole 0..1 Reference(PractitionerRoleLiteSe) Who is responsible for the observation
.... performer:practitioner 0..1 Reference(Practitioner) Who is responsible for the observation
... dataAbsentReason 0..0
... interpretation 0..0
... note 0..1 Annotation Comments about the observation
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 6..6 Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.statusrequiredVitalSignStatus
https://cambio.codes/fhir/vs/vital-sign-status/v1
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationNews2Core Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code preliminary | final | entered-in-error | cancelled
Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 1104051000000101
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Patient) Who and/or what the observation is about
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for observation
... Slices for performer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Who is responsible for the observation
Slice: Unordered, Open by type:$this
.... performer:organization Σ 0..1 Reference(OrganizationSEVendorLite) Who is responsible for the observation
.... performer:practitionerRole Σ 0..1 Reference(PractitionerRoleLiteSe) Who is responsible for the observation
.... performer:practitioner Σ 0..1 Reference(Practitioner) Who is responsible for the observation
... value[x] ΣC 0..1 Quantity Actual result
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit
... note 0..1 Annotation Comments about the observation
... derivedFrom Σ 6..6 Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Observation.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Observation.statusrequiredVitalSignStatus
https://cambio.codes/fhir/vs/vital-sign-status/v1
From this IG
Observation.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
From the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
From the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
From the FHIR Standard
Observation.component.codeexampleLOINCCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
From the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
From the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
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-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

 

Other representations of profile: CSV, Excel, Schematron