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
| Official URL: https://fhir.cambio.se/StructureDefinition/ObservationNews2Lite/v1 | Version: 1.1.0 | |||
| Active as of 2022-09-09 | Computable Name: ObservationNews2Lite | |||
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.
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.
| 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. | 
| 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. | 
| 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 | 
| 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 | 
GET [baseURL]/Observation/_search?patient= (search)GET [baseURL]/Observation/_search?status= (search)GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (search)GET [baseURL]/Observation/_search?_profile= (search)GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (search)GET [baseURL]/Observation/_search?status=[status]&_include=[] (search)GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[]GET [baseURL]/Observation/_search?_profile=[url]&_include=[]POST [baseURL]/ObservationObservation:performer
Observation.derivedFrom
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | ObservationNews2Core | Measurements and simple assertions Constraints: obs-6, obs-7  | 
![]() ![]()  | 
Σ | 1..1 | Meta | Metadata about the resource | 
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 1..1 | code | preliminary | final | entered-in-error | cancelled Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.  | 
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.  | 
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about | 
![]() ![]()  | 
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation | 
![]() ![]()  | 
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the observation Slice: Unordered, Open by type:$this  | 
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(OrganizationSEVendorLite) | Who is responsible for the observation | 
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is responsible for the observation | 
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner) | Who is responsible for the observation | 
![]() ![]()  | 
0..1 | Annotation | Comments about the observation | |
![]() ![]()  | 
Σ | 6..6 | Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) | Related measurements the observation is made from | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Observation.status | required | VitalSignStatushttps://cambio.codes/fhir/vs/vital-sign-status/v1From this IG  | |
| Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()  | |
| obs-7 | error | Observation | If 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
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | ObservationNews2Core | Measurements and simple assertions | |
![]() ![]()  | 
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]()  | 
S | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | code | preliminary | final | entered-in-error | cancelled Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.  | |
![]() ![]()  | 
1..1 | Reference(Patient) | Who and/or what the observation is about | |
![]() ![]()  | 
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the observation Slice: Unordered, Open by type:$this  | |
![]() ![]() ![]()  | 
0..1 | Reference(OrganizationSEVendorLite) | Who is responsible for the observation | |
![]() ![]() ![]()  | 
0..1 | Reference(PractitionerRoleLiteSe) | Who is responsible for the observation | |
![]() ![]() ![]()  | 
0..1 | Reference(Practitioner) | Who is responsible for the observation | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..1 | Annotation | Comments about the observation | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
6..6 | Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) | Related measurements the observation is made from | |
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Observation.status | required | VitalSignStatushttps://cambio.codes/fhir/vs/vital-sign-status/v1From this IG  | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | ObservationNews2Core | Measurements and simple assertions Constraints: obs-6, obs-7  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.  | ||||
![]() ![]() ![]()  | 
Σ | 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".  | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
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  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | Business Identifier for observation | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | ||||
![]() ![]() ![]()  | 
Σ | 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.  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]()  | 
?!Σ | 1..1 | code | preliminary | final | entered-in-error | cancelled Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.  | ||||
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1104051000000101  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
![]() ![]()  | 
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
![]() ![]()  | 
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation | ||||
![]() ![]()  | 
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the observation Slice: Unordered, Open by type:$this  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(OrganizationSEVendorLite) | Who is responsible for the observation | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is responsible for the observation | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner) | Who is responsible for the observation | ||||
![]() ![]()  | 
ΣC | 0..1 | Quantity | Actual result | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | code | Coded form of the unit | ||||
![]() ![]()  | 
0..1 | Annotation | Comments about the observation | |||||
![]() ![]()  | 
Σ | 6..6 | Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) | Related measurements the observation is made from | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard  | ||||
| Observation.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard  | ||||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Observation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard  | ||||
| Observation.status | required | VitalSignStatushttps://cambio.codes/fhir/vs/vital-sign-status/v1From this IG  | ||||
| Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | ||||
| Observation.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard  | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard  | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard  | ||||
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard  | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()  | |
| obs-7 | error | Observation | If 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
Summary
Mandatory: 3 elements
 Must-Support: 1 element
 Prohibited: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | ObservationNews2Core | Measurements and simple assertions Constraints: obs-6, obs-7  | 
![]() ![]()  | 
Σ | 1..1 | Meta | Metadata about the resource | 
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 1..1 | code | preliminary | final | entered-in-error | cancelled Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.  | 
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.  | 
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about | 
![]() ![]()  | 
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation | 
![]() ![]()  | 
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the observation Slice: Unordered, Open by type:$this  | 
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(OrganizationSEVendorLite) | Who is responsible for the observation | 
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is responsible for the observation | 
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner) | Who is responsible for the observation | 
![]() ![]()  | 
0..1 | Annotation | Comments about the observation | |
![]() ![]()  | 
Σ | 6..6 | Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) | Related measurements the observation is made from | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Observation.status | required | VitalSignStatushttps://cambio.codes/fhir/vs/vital-sign-status/v1From this IG  | |
| Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | |
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()  | |
| obs-7 | error | Observation | If 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
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | ObservationNews2Core | Measurements and simple assertions | |
![]() ![]()  | 
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]()  | 
S | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | code | preliminary | final | entered-in-error | cancelled Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.  | |
![]() ![]()  | 
1..1 | Reference(Patient) | Who and/or what the observation is about | |
![]() ![]()  | 
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the observation Slice: Unordered, Open by type:$this  | |
![]() ![]() ![]()  | 
0..1 | Reference(OrganizationSEVendorLite) | Who is responsible for the observation | |
![]() ![]() ![]()  | 
0..1 | Reference(PractitionerRoleLiteSe) | Who is responsible for the observation | |
![]() ![]() ![]()  | 
0..1 | Reference(Practitioner) | Who is responsible for the observation | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..1 | Annotation | Comments about the observation | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
6..6 | Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) | Related measurements the observation is made from | |
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Observation.status | required | VitalSignStatushttps://cambio.codes/fhir/vs/vital-sign-status/v1From this IG  | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | ObservationNews2Core | Measurements and simple assertions Constraints: obs-6, obs-7  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.  | ||||
![]() ![]() ![]()  | 
Σ | 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".  | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
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  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | Business Identifier for observation | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | ||||
![]() ![]() ![]()  | 
Σ | 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.  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]()  | 
?!Σ | 1..1 | code | preliminary | final | entered-in-error | cancelled Binding: VitalSignStatus (required): Subset of codes providing the status of an observation.  | ||||
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1104051000000101  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]()  | 
Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
![]() ![]()  | 
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
![]() ![]()  | 
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation | ||||
![]() ![]()  | 
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the observation Slice: Unordered, Open by type:$this  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(OrganizationSEVendorLite) | Who is responsible for the observation | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is responsible for the observation | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner) | Who is responsible for the observation | ||||
![]() ![]()  | 
ΣC | 0..1 | Quantity | Actual result | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | code | Coded form of the unit | ||||
![]() ![]()  | 
0..1 | Annotation | Comments about the observation | |||||
![]() ![]()  | 
Σ | 6..6 | Reference(ObservationRespiratoryRateLite | ObservationBPLite | ObservationHeartRateLite | ObservationAcvpuLite | ObservationOxygenSaturationLite | ObservationBodyTemperatureLite) | Related measurements the observation is made from | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard  | ||||
| Observation.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard  | ||||
| Observation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Observation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard  | ||||
| Observation.status | required | VitalSignStatushttps://cambio.codes/fhir/vs/vital-sign-status/v1From this IG  | ||||
| Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | ||||
| Observation.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1From the FHIR Standard  | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningFrom the FHIR Standard  | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestoFrom the FHIR Standard  | ||||
| Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesFrom the FHIR Standard  | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonFrom the FHIR Standard  | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationFrom the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()  | |
| obs-7 | error | Observation | If 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
Summary
Mandatory: 3 elements
 Must-Support: 1 element
 Prohibited: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron