International Patient Access
1.1.0 - STU1 International flag

International Patient Access, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions

Resource Profile: IPA-Observation

Official URL: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation Version: 1.1.0
Standards status: Trial-use Computable Name: IPAObservation

Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License

Minimum expectations for an Observation resource when accessed via a International Patient Access API

Mandatory and Must Support Data Elements

The following data elements must always be present (in other words, mandatory resource properties where the minimum cardinality is 1) or must be supported (Must Support definition). Servers cannot restrict access to mandatory elements when authorizing an application. However, servers may choose to provide additional information or may be required to do so by national or other profiles that apply to the server's context.

Each Observation SHALL have:

  • a status
  • a code identifying the type of observation
  • a person

Applications must also support:

  • one or more category codes used to group observations
  • clinically relevant time/time-period for the observation
  • the observation result value
  • a reason why the result value is missing

Profile Specific Implementation Rules and Guidance

Note that the base FHIR specification defines a profile on the Observation resource used to specifically represent vitals signs. To adhere to IPA as well as the base FHIR specifications, implementers SHALL support the FHIR Core Vitals Signs profile.

The IPA-Observation profile defined here SHALL be used to represent Observations other than vital signs such as:

  • Laboratory data (for example, blood glucose)
  • Imaging or clinical test results (for example, bone density or electrocardiogram (ECG))
  • Social history (for example, tobacco use or occupation data1)
  • General health status (for example, pregnancy status)

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
ipa-obs-1: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!SOΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Server
SHALL:handle Client
... code SOΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Server
SHALL:handle Client
... subject SOΣ 1..1 Reference(IPA-Patient) Who and/or what the observation is about
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Server
SHALL:handle Client
... effective[x] SOΣ 0..1 Clinically relevant time/time-period for observation
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Server
SHALL:handle Client
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... value[x] SOΣC 0..1 Actual result
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Server
SHALL:handle Client
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason SOC 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Server
SHALL:handle Client

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ipa-obs-1errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason or value)

 

Other representations of profile: CSV, Excel, Schematron

Notes: