HL7.FHIR.UV.IPA\IPA-Observation

International Patient Access
0.1.0 - STU 1 ballot

This page is part of the International Patient Access (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: IPA-Observation

Defining URL:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation

Version:

0.1.0

Name:

IPAObservation

Title:

IPA-Observation

Status:

Draft as of 8/26/19 3:10 PM

Definition:

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

Publisher:

HL7 International - Patient Care Workgroup

Copyright:

Creative Commons Public Domain

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Observation

Summary

Mandatory: 4 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

IPA-Patient (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient)

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	Measurements and simple assertions ipa-obs-1: If there is no component or related element then either a value[x] or a data absent reason must be present
status	S	1..1	code	registered \| preliminary \| final \| amended +
category	S	1..*	CodeableConcept	Classification of type of observation
code	S	1..1	CodeableConcept	Type of observation (code / type)
subject	S	1..1	Reference(IPA-Patient)	Who and/or what the observation is about
effective[x]	S	0..1	dateTime, Period, Timing, instant	Clinically relevant time/time-period for observation
value[x]	S	0..1	Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period	Actual result
dataAbsentReason	S	0..1	CodeableConcept	Why the result is missing
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	Measurements and simple assertions ipa-obs-1: If there is no component or related element then either a value[x] or a data absent reason must be present
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
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
basedOn	Σ	0..*	Reference(CarePlan \| DeviceRequest \| ImmunizationRecommendation \| MedicationRequest \| NutritionOrder \| ServiceRequest)	Fulfills plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration \| MedicationDispense \| MedicationStatement \| Procedure \| Immunization \| ImagingStudy)	Part of referenced event
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category	S	1..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	SΣ	1..1	CodeableConcept	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
subject	SΣ	1..1	Reference(IPA-Patient)	Who and/or what the observation is about
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	SΣ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation
value[x]	SΣI	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	SI	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
bodySite		0..1	CodeableConcept	Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen		0..1	Reference(Specimen)	Specimen used for this observation
device		0..1	Reference(Device \| DeviceMetric)	(Measurement) Device
referenceRange	I	0..*	BackboneElement	Provides guide for interpretation obs-3: Must have at least a low or a high or text
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
low	I	0..1	SimpleQuantity	Low Range, if relevant
high	I	0..1	SimpleQuantity	High Range, if relevant
type		0..1	CodeableConcept	Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo		0..*	CodeableConcept	Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age		0..1	Range	Applicable age range, if relevant
text		0..1	string	Text based reference range in an observation
hasMember	Σ	0..*	Reference(Observation \| QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..*	Reference(DocumentReference \| ImagingStudy \| Media \| QuestionnaireResponse \| Observation \| MolecularSequence)	Related measurements the observation is made from
component	Σ	0..*	BackboneElement	Component results
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
value[x]	Σ	0..1		Actual component result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	I	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange		0..*	See referenceRange (Observation)	Provides guide for interpretation of component result
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	Measurements and simple assertions ipa-obs-1: If there is no component or related element then either a value[x] or a data absent reason must be present
status	?!Σ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category		1..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	Σ	1..1	CodeableConcept	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
subject	Σ	1..1	Reference(IPA-Patient)	Who and/or what the observation is about
effective[x]	Σ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
value[x]	ΣI	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	I	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 4 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

IPA-Patient (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient)

Differential View

This structure is derived from Observation

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	Measurements and simple assertions ipa-obs-1: If there is no component or related element then either a value[x] or a data absent reason must be present
status	S	1..1	code	registered \| preliminary \| final \| amended +
category	S	1..*	CodeableConcept	Classification of type of observation
code	S	1..1	CodeableConcept	Type of observation (code / type)
subject	S	1..1	Reference(IPA-Patient)	Who and/or what the observation is about
effective[x]	S	0..1	dateTime, Period, Timing, instant	Clinically relevant time/time-period for observation
value[x]	S	0..1	Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period	Actual result
dataAbsentReason	S	0..1	CodeableConcept	Why the result is missing
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	Measurements and simple assertions ipa-obs-1: If there is no component or related element then either a value[x] or a data absent reason must be present
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
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
basedOn	Σ	0..*	Reference(CarePlan \| DeviceRequest \| ImmunizationRecommendation \| MedicationRequest \| NutritionOrder \| ServiceRequest)	Fulfills plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration \| MedicationDispense \| MedicationStatement \| Procedure \| Immunization \| ImagingStudy)	Part of referenced event
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category	S	1..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	SΣ	1..1	CodeableConcept	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
subject	SΣ	1..1	Reference(IPA-Patient)	Who and/or what the observation is about
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	SΣ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation
value[x]	SΣI	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	SI	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
bodySite		0..1	CodeableConcept	Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen		0..1	Reference(Specimen)	Specimen used for this observation
device		0..1	Reference(Device \| DeviceMetric)	(Measurement) Device
referenceRange	I	0..*	BackboneElement	Provides guide for interpretation obs-3: Must have at least a low or a high or text
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
low	I	0..1	SimpleQuantity	Low Range, if relevant
high	I	0..1	SimpleQuantity	High Range, if relevant
type		0..1	CodeableConcept	Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo		0..*	CodeableConcept	Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age		0..1	Range	Applicable age range, if relevant
text		0..1	string	Text based reference range in an observation
hasMember	Σ	0..*	Reference(Observation \| QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..*	Reference(DocumentReference \| ImagingStudy \| Media \| QuestionnaireResponse \| Observation \| MolecularSequence)	Related measurements the observation is made from
component	Σ	0..*	BackboneElement	Component results
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
value[x]	Σ	0..1		Actual component result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	I	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange		0..*	See referenceRange (Observation)	Provides guide for interpretation of component result
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Observation.language	preferred	CommonLanguages Max Binding: AllLanguages
Observation.status	required	ObservationStatus
Observation.category	preferred	ObservationCategoryCodes
Observation.code	example	LOINCCodes
Observation.dataAbsentReason	extensible	DataAbsentReason
Observation.interpretation	extensible	ObservationInterpretationCodes
Observation.bodySite	example	SNOMEDCTBodyStructures
Observation.method	example	ObservationMethods
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes
Observation.component.code	example	LOINCCodes
Observation.component.dataAbsentReason	extensible	DataAbsentReason
Observation.component.interpretation	extensible	ObservationInterpretationCodes

Constraints

Id	Path	Details	Requirements
ipa-obs-1	Observation	If there is no component or related element then either a value[x] or a data absent reason must be present : (component.empty() and related.empty()) implies (dataAbsentReason or value)
obs-3	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()