Profile - Athena Observation - Implementation Guide v25.0.0

Publish Box goes here

Resource Profile: Profile - Athena Observation

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-observation-profile.html				Version: 25.0.0
Active as of 2022-03-01				Computable Name: AthenaObservation

athena observation profile

This Observation profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search, create and update capabilities of these products.

Overview

This resource captures measurements and simple assertions made about a patient, device, or other subject.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Observation resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

The profile also defines the content that must be supplied to the API Server in response to requests to populate Observation resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.

Source

The Observation resource is derived from the OBS and other related tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

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.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Observation	C	0..*	Observation	Measurements and simple assertions Constraints: obs-6, obs-7
id	SΣ	0..1	id	Unique Id for this particular observation
meta	SΣ	0..1	Meta	Unique Id for this particular observation
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
Slices for profile	Σ	2..*	canonical()	Profiles this resource claims to conform to Slice: Unordered, Open by value:uri
profile:HL7 TravelHistory Profile	Σ	1..1	canonical()	Profiles this resource claims to conform to
profile:Athena Allergy Profile	Σ	1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
profile:US Core Observation Lab Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterms with category Laboratory
profile:US Core Pediatric BMI For Age Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Pulse Oximetry Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 2173
profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 5346
profile:US Core Pediatric Weight For Height Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 29139
profile:US Core Smokingstatus Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 72166-2
profile:US Core Blood Pressure Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID BP-PANEL
profile:US Core Disability Status Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 245720
profile:US Core FOODWORRY Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568877
profile:US Core FOODRANOUT Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568878
profile:US Core Observation sdoh Assessment	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile:US Core Observation Screening Assessment	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568877
profile:US Core BMI Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Body Height Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 55
profile:US Core Body Weight Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3141-9
profile:US Core Body Temperature Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8310-5
profile:US Core Heart Rate Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8867-4
profile:US Core Respiratory Rate Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 9279-1
profile:US Core Observation Clinical Result Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3024-7
profile:US Core Observation Occupation Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 11341-5
profile:US Core Observation Pregnancy Intent Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Pregnancy Status Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Sexual Orientation Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC 76690-7
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568878
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
Slices for security	Σ	0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:SENSITIVECHART	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:CONFABBR	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
tag	Σ	1..2	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
Slices for extension				Content/Rules for all slices
extension:ExactCodeDesctiption		0..1	?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription]]	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription"
value[x]		1..1	CodeableConcept	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique Id for this particular observation
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
Slices for category		0..1	CodeableConcept	Classification of type of observation Slice: Unordered, Open by value:CodeableConcept Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:FHIRCATEGORY		0..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
coding	Σ	0..1	Coding	Code defined by a terminology system
category:PANELCATEGORY		0..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
coding	Σ	0..1	Coding	Code defined by a terminology system
category:HG_GROUPID		0..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
coding	Σ	0..1	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
code	SΣ	1..1	CodeableConcept	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..4	Coding	Code defined by a terminology system Slice: Unordered, Open by value:coding
coding	Σ	0..1	Coding	Code defined by a terminology system
coding	Σ	0..1	Coding	Code defined by a terminology system
coding	Σ	0..1	Coding	Code defined by a terminology system
coding	Σ	0..1	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
subject	SΣ	0..1	Reference(Patient)	Who and/or what this is about
encounter	SΣ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	Σ	0..*		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
issued	SΣ	0..1	instant	Date/Time this was made available
Slices for performer	Σ	1..2	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation Slice: Unordered, Open by value:type
performer:PractitionerPerformer	SΣ	1..1	Reference(Practitioner)	Who is responsible for the observation
performer:OrganizationPerformer	SΣ	0..1	Reference(Organization)	Who is responsible for the observation
value[x]	SΣC	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
dataAbsentReason	C	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..1	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..1	Annotation	Comments about result
specimen	S	0..1	Reference(Specimen)	Specimen used for this observation
referenceRange	C	0..1	BackboneElement	Provides guide for interpretation Constraints: obs-3
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		0..1	string	Provides guide for interpretation
hasMember	Σ	0..*	Reference(Observation)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..1	Reference(Observation)	Related measurements the observation is made from
component	Σ	0..1	BackboneElement	Only supported for USCore pulse Oximetry profile Slice: Unordered, Open by value:component
component:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Code defined by a terminology system
value[x]	Σ	0..1	Quantity	Actual component result
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
component	SΣ	1..1	BackboneElement	Travel location
Slices for extension				Content/Rules for all slices
extension:ADDRESSEXTENSION		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension]]	Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension"
value[x]		1..1	Address	Value of extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Travel location code Slice: Unordered, Open by value:code.coding
value[x]	Σ	1..1	CodeableConcept	Actual component result
coding	Σ	1..*	Coding	contryCode coding
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
component	SΣ	0..1	BackboneElement	occupationIndustryCode
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code.coding
value[x]	Σ	1..1	CodeableConcept	Actual component result
coding	Σ	1..*	Coding	Code defined by a terminology system
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
component	SΣ	0..1	BackboneElement	Purpose of travel
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Purpose of travel coding Slice: Unordered, Open by value:code.coding
value[x]	Σ	1..1	CodeableConcept	Actual component result
coding	Σ	1..*	Coding	Code defined by a terminology system
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Observation.meta.security	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Observation.meta.security:SENSITIVECHART	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Observation.meta.security:CONFABBR	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Observation.meta.tag	example	CommonTags `http://hl7.org/fhir/ValueSet/common-tags` From the FHIR Standard
Observation.status	required	ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:FHIRCATEGORY	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:PANELCATEGORY	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:HG_GROUPID	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.interpretation	extensible	ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard

Constraints

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-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.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 Observation

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Observation		0..*	Observation	Measurements and simple assertions
id	S	0..1	id	Unique Id for this particular observation
meta	S	0..1	Meta	Unique Id for this particular observation
versionId		0..1	id	Version specific identifier
lastUpdated		0..1	instant	When the resource version last changed
Slices for profile		2..*	canonical()	Profiles this resource claims to conform to Slice: Unordered, Open by value:uri
profile:HL7 TravelHistory Profile		1..1	canonical()	Profiles this resource claims to conform to
profile:Athena Allergy Profile		1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
profile:US Core Observation Lab Profile		0..1	canonical()	This USCore profile is supported only for obsterms with category Laboratory
profile:US Core Pediatric BMI For Age Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Pulse Oximetry Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 2173
profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 5346
profile:US Core Pediatric Weight For Height Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 29139
profile:US Core Smokingstatus Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 72166-2
profile:US Core Blood Pressure Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID BP-PANEL
profile:US Core Disability Status Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 245720
profile:US Core FOODWORRY Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568877
profile:US Core FOODRANOUT Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568878
profile:US Core Observation sdoh Assessment		0..1	canonical()	Profiles this resource claims to conform to
profile:US Core Observation Screening Assessment		0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568877
profile:US Core BMI Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Body Height Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 55
profile:US Core Body Weight Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3141-9
profile:US Core Body Temperature Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8310-5
profile:US Core Heart Rate Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8867-4
profile:US Core Respiratory Rate Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 9279-1
profile:US Core Observation Clinical Result Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3024-7
profile:US Core Observation Occupation Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 11341-5
profile:US Core Observation Pregnancy Intent Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Pregnancy Status Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Sexual Orientation Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC 76690-7
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568878
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
Slices for security		0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:coding
security:SENSITIVECHART		0..1	Coding	Security Labels applied to this resource
security:CONFABBR		0..1	Coding	Security Labels applied to this resource
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
tag		1..2	Coding	Tags applied to this resource
Slices for extension				Content/Rules for all slices
extension:ExactCodeDesctiption		0..1	?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription]]	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription"
value[x]		1..1	CodeableConcept	Value of extension
identifier		0..*	Identifier	Unique Id for this particular observation
status	S	1..1	code	registered \| preliminary \| final \| amended +
Slices for category		0..1	CodeableConcept	Classification of type of observation Slice: Unordered, Open by value:CodeableConcept
category:FHIRCATEGORY		0..1	CodeableConcept	Classification of type of observation
coding		0..1	Coding	Code defined by a terminology system
category:PANELCATEGORY		0..1	CodeableConcept	Classification of type of observation
coding		0..1	Coding	Code defined by a terminology system
category:HG_GROUPID		0..1	CodeableConcept	Classification of type of observation
coding		0..1	Coding	Code defined by a terminology system
text		0..1	string	Plain text representation of the concept
code	S	1..1	CodeableConcept	Type of observation (code / type)
coding		0..4	Coding	Code defined by a terminology system Slice: Unordered, Open by value:coding
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:TOCODE
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:HDID
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:C1_CODE
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:C2_CODE
text		0..1	string	Plain text representation of the concept
subject	S	0..1	Reference(Patient)	Who and/or what this is about
encounter	S	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]		0..*		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
issued	S	0..1	instant	Date/Time this was made available
Slices for performer		1..2	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation Slice: Unordered, Open by value:type
performer:PractitionerPerformer	S	1..1	Reference(Practitioner)	Who is responsible for the observation
performer:OrganizationPerformer	S	0..1	Reference(Organization)	Who is responsible for the observation
value[x]	S	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
dataAbsentReason		0..1	CodeableConcept	Why the result is missing
interpretation		0..1	CodeableConcept	High, low, normal, etc.
note		0..1	Annotation	Comments about result
specimen	S	0..1	Reference(Specimen)	Specimen used for this observation
referenceRange		0..1	BackboneElement	Provides guide for interpretation
text		0..1	string	Provides guide for interpretation
hasMember		0..*	Reference(Observation)	Related resource that belongs to the Observation group
derivedFrom		0..1	Reference(Observation)	Related measurements the observation is made from
component		0..1	BackboneElement	Only supported for USCore pulse Oximetry profile Slice: Unordered, Open by value:component
component:All Slices				Content/Rules for all slices
code		0..1	CodeableConcept	Type of component observation (code / type)
coding		0..1	Coding	Code defined by a terminology system
value[x]		0..1	Quantity	Actual component result
dataAbsentReason		0..1	CodeableConcept	Why the component result is missing
component	S	1..*	BackboneElement	Travel location Slice: Unordered, Open by value:travelLocation
component:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
extension:ADDRESSEXTENSION		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension]]	Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension"
value[x]		1..1	Address	Value of extension
code		0..1	CodeableConcept	Type of component observation (code / type) Slice: Unordered, Open by value:code
code:All Slices				Content/Rules for all slices
coding		0..1	Coding	Travel location code Slice: Unordered, Open by value:code.coding
value[x]		1..1	CodeableConcept	Actual component result
coding		1..*	Coding	contryCode coding
component	S	0..*	BackboneElement	occupationIndustryCode Slice: Unordered, Open by value:occupationIndustry
component:All Slices				Content/Rules for all slices
code		0..1	CodeableConcept	Type of component observation (code / type) Slice: Unordered, Open by value:code
code:All Slices				Content/Rules for all slices
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code.coding
value[x]		1..1	CodeableConcept	Actual component result
coding		1..*	Coding	Code defined by a terminology system
component	S	0..*	BackboneElement	Purpose of travel Slice: Unordered, Open by value:travelPurpose
component:All Slices				Content/Rules for all slices
code		0..1	CodeableConcept	Type of component observation (code / type) Slice: Unordered, Open by value:code
code:All Slices				Content/Rules for all slices
coding		0..1	Coding	Purpose of travel coding Slice: Unordered, Open by value:code.coding
value[x]		1..1	CodeableConcept	Actual component result
coding		1..*	Coding	Code defined by a terminology system
Documentation for this format

Description & Constraints Filter: Filters

Observation

0..*

Observation

Measurements and simple assertions
Constraints: obs-6, obs-7

SΣ

0..1

Unique Id for this particular observation

Terminology Bindings

Path Conformance ValueSet URI

Observation.meta.security

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

From the FHIR Standard

Observation.meta.security:SENSITIVECHART

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

From the FHIR Standard

Observation.meta.security:CONFABBR

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

From the FHIR Standard

Observation.meta.tag

example

CommonTags

http://hl7.org/fhir/ValueSet/common-tags

From the FHIR Standard

Observation.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

From the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Observation.status

required

ObservationStatus

http://hl7.org/fhir/ValueSet/observation-status|4.0.1

From the FHIR Standard

Observation.category

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.category:FHIRCATEGORY

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.category:PANELCATEGORY

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.category:HG_GROUPID

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.bodySite

example

SNOMEDCTBodyStructures

http://hl7.org/fhir/ValueSet/body-site

From the FHIR Standard

Observation.method

example

ObservationMethods

http://hl7.org/fhir/ValueSet/observation-methods

From the FHIR Standard

Observation.referenceRange.type

preferred

ObservationReferenceRangeMeaningCodes

http://hl7.org/fhir/ValueSet/referencerange-meaning

From the FHIR Standard

Observation.referenceRange.appliesTo

example

ObservationReferenceRangeAppliesToCodes

http://hl7.org/fhir/ValueSet/referencerange-appliesto

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Constraints

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-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.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 Observation

Summary

Mandatory: 7 elements(13 nested mandatory elements)
Must-Support: 14 elements
Fixed: 3 elements

Extensions

This structure refers to these extensions:

Unable to summarise extension https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription (no extension found)
Unable to summarise extension http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension (no extension found)

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Observation.meta.profile
The element 1 is sliced based on the value of Observation.meta.security
The element 1 is sliced based on the value of Observation.category
The element 1 is sliced based on the value of Observation.code.coding
The element 1 is sliced based on the value of Observation.performer
The element 1 is sliced based on the value of Observation.component
The element 1 is sliced based on the value of Observation.component.code
The element 1 is sliced based on the value of Observation.component.code.coding

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Observation	C	0..*	Observation	Measurements and simple assertions Constraints: obs-6, obs-7
id	SΣ	0..1	id	Unique Id for this particular observation
meta	SΣ	0..1	Meta	Unique Id for this particular observation
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
Slices for profile	Σ	2..*	canonical()	Profiles this resource claims to conform to Slice: Unordered, Open by value:uri
profile:HL7 TravelHistory Profile	Σ	1..1	canonical()	Profiles this resource claims to conform to
profile:Athena Allergy Profile	Σ	1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
profile:US Core Observation Lab Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterms with category Laboratory
profile:US Core Pediatric BMI For Age Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Pulse Oximetry Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 2173
profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 5346
profile:US Core Pediatric Weight For Height Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 29139
profile:US Core Smokingstatus Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 72166-2
profile:US Core Blood Pressure Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID BP-PANEL
profile:US Core Disability Status Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 245720
profile:US Core FOODWORRY Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568877
profile:US Core FOODRANOUT Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568878
profile:US Core Observation sdoh Assessment	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile:US Core Observation Screening Assessment	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568877
profile:US Core BMI Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Body Height Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 55
profile:US Core Body Weight Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3141-9
profile:US Core Body Temperature Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8310-5
profile:US Core Heart Rate Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8867-4
profile:US Core Respiratory Rate Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 9279-1
profile:US Core Observation Clinical Result Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3024-7
profile:US Core Observation Occupation Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 11341-5
profile:US Core Observation Pregnancy Intent Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Pregnancy Status Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Sexual Orientation Profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with LOINC 76690-7
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568878
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
profile	Σ	0..1	canonical()	Profiles this resource claims to conform to
Slices for security	Σ	0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:SENSITIVECHART	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:CONFABBR	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
tag	Σ	1..2	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
Slices for extension				Content/Rules for all slices
extension:ExactCodeDesctiption		0..1	?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription]]	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription"
value[x]		1..1	CodeableConcept	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique Id for this particular observation
status	?!SΣ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
Slices for category		0..1	CodeableConcept	Classification of type of observation Slice: Unordered, Open by value:CodeableConcept Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:FHIRCATEGORY		0..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
coding	Σ	0..1	Coding	Code defined by a terminology system
category:PANELCATEGORY		0..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
coding	Σ	0..1	Coding	Code defined by a terminology system
category:HG_GROUPID		0..1	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
coding	Σ	0..1	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
code	SΣ	1..1	CodeableConcept	Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..4	Coding	Code defined by a terminology system Slice: Unordered, Open by value:coding
coding	Σ	0..1	Coding	Code defined by a terminology system
coding	Σ	0..1	Coding	Code defined by a terminology system
coding	Σ	0..1	Coding	Code defined by a terminology system
coding	Σ	0..1	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
subject	SΣ	0..1	Reference(Patient)	Who and/or what this is about
encounter	SΣ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	Σ	0..*		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
issued	SΣ	0..1	instant	Date/Time this was made available
Slices for performer	Σ	1..2	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation Slice: Unordered, Open by value:type
performer:PractitionerPerformer	SΣ	1..1	Reference(Practitioner)	Who is responsible for the observation
performer:OrganizationPerformer	SΣ	0..1	Reference(Organization)	Who is responsible for the observation
value[x]	SΣC	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
dataAbsentReason	C	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..1	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..1	Annotation	Comments about result
specimen	S	0..1	Reference(Specimen)	Specimen used for this observation
referenceRange	C	0..1	BackboneElement	Provides guide for interpretation Constraints: obs-3
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		0..1	string	Provides guide for interpretation
hasMember	Σ	0..*	Reference(Observation)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..1	Reference(Observation)	Related measurements the observation is made from
component	Σ	0..1	BackboneElement	Only supported for USCore pulse Oximetry profile Slice: Unordered, Open by value:component
component:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Code defined by a terminology system
value[x]	Σ	0..1	Quantity	Actual component result
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
component	SΣ	1..1	BackboneElement	Travel location
Slices for extension				Content/Rules for all slices
extension:ADDRESSEXTENSION		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension]]	Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension"
value[x]		1..1	Address	Value of extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Travel location code Slice: Unordered, Open by value:code.coding
value[x]	Σ	1..1	CodeableConcept	Actual component result
coding	Σ	1..*	Coding	contryCode coding
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
component	SΣ	0..1	BackboneElement	occupationIndustryCode
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code.coding
value[x]	Σ	1..1	CodeableConcept	Actual component result
coding	Σ	1..*	Coding	Code defined by a terminology system
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
component	SΣ	0..1	BackboneElement	Purpose of travel
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
coding	Σ	0..1	Coding	Purpose of travel coding Slice: Unordered, Open by value:code.coding
value[x]	Σ	1..1	CodeableConcept	Actual component result
coding	Σ	1..*	Coding	Code defined by a terminology system
dataAbsentReason	C	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Observation.meta.security	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Observation.meta.security:SENSITIVECHART	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Observation.meta.security:CONFABBR	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Observation.meta.tag	example	CommonTags `http://hl7.org/fhir/ValueSet/common-tags` From the FHIR Standard
Observation.status	required	ObservationStatus `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` From the FHIR Standard
Observation.category	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:FHIRCATEGORY	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:PANELCATEGORY	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:HG_GROUPID	preferred	ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.interpretation	extensible	ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.code	example	LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason	extensible	DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard

Constraints

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-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.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 Observation

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Observation		0..*	Observation	Measurements and simple assertions
id	S	0..1	id	Unique Id for this particular observation
meta	S	0..1	Meta	Unique Id for this particular observation
versionId		0..1	id	Version specific identifier
lastUpdated		0..1	instant	When the resource version last changed
Slices for profile		2..*	canonical()	Profiles this resource claims to conform to Slice: Unordered, Open by value:uri
profile:HL7 TravelHistory Profile		1..1	canonical()	Profiles this resource claims to conform to
profile:Athena Allergy Profile		1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
profile:US Core Observation Lab Profile		0..1	canonical()	This USCore profile is supported only for obsterms with category Laboratory
profile:US Core Pediatric BMI For Age Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Pulse Oximetry Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 2173
profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 5346
profile:US Core Pediatric Weight For Height Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 29139
profile:US Core Smokingstatus Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 72166-2
profile:US Core Blood Pressure Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID BP-PANEL
profile:US Core Disability Status Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 245720
profile:US Core FOODWORRY Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568877
profile:US Core FOODRANOUT Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 568878
profile:US Core Observation sdoh Assessment		0..1	canonical()	Profiles this resource claims to conform to
profile:US Core Observation Screening Assessment		0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568877
profile:US Core BMI Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 22346
profile:US Core Body Height Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 55
profile:US Core Body Weight Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3141-9
profile:US Core Body Temperature Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8310-5
profile:US Core Heart Rate Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 8867-4
profile:US Core Respiratory Rate Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 9279-1
profile:US Core Observation Clinical Result Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 3024-7
profile:US Core Observation Occupation Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC code 11341-5
profile:US Core Observation Pregnancy Intent Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Pregnancy Status Profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDID 21347
profile:US Core Observation Sexual Orientation Profile		0..1	canonical()	This USCore profile is supported only for obsterm with LOINC 76690-7
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	This USCore profile is supported only for obsterm with HDIDs 245720 and 568878
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
profile		0..1	canonical()	Profiles this resource claims to conform to
Slices for security		0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:coding
security:SENSITIVECHART		0..1	Coding	Security Labels applied to this resource
security:CONFABBR		0..1	Coding	Security Labels applied to this resource
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
tag		1..2	Coding	Tags applied to this resource
Slices for extension				Content/Rules for all slices
extension:ExactCodeDesctiption		0..1	?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription]]	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription"
value[x]		1..1	CodeableConcept	Value of extension
identifier		0..*	Identifier	Unique Id for this particular observation
status	S	1..1	code	registered \| preliminary \| final \| amended +
Slices for category		0..1	CodeableConcept	Classification of type of observation Slice: Unordered, Open by value:CodeableConcept
category:FHIRCATEGORY		0..1	CodeableConcept	Classification of type of observation
coding		0..1	Coding	Code defined by a terminology system
category:PANELCATEGORY		0..1	CodeableConcept	Classification of type of observation
coding		0..1	Coding	Code defined by a terminology system
category:HG_GROUPID		0..1	CodeableConcept	Classification of type of observation
coding		0..1	Coding	Code defined by a terminology system
text		0..1	string	Plain text representation of the concept
code	S	1..1	CodeableConcept	Type of observation (code / type)
coding		0..4	Coding	Code defined by a terminology system Slice: Unordered, Open by value:coding
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:TOCODE
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:HDID
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:C1_CODE
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:C2_CODE
text		0..1	string	Plain text representation of the concept
subject	S	0..1	Reference(Patient)	Who and/or what this is about
encounter	S	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]		0..*		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
issued	S	0..1	instant	Date/Time this was made available
Slices for performer		1..2	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation Slice: Unordered, Open by value:type
performer:PractitionerPerformer	S	1..1	Reference(Practitioner)	Who is responsible for the observation
performer:OrganizationPerformer	S	0..1	Reference(Organization)	Who is responsible for the observation
value[x]	S	0..1		Actual result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
dataAbsentReason		0..1	CodeableConcept	Why the result is missing
interpretation		0..1	CodeableConcept	High, low, normal, etc.
note		0..1	Annotation	Comments about result
specimen	S	0..1	Reference(Specimen)	Specimen used for this observation
referenceRange		0..1	BackboneElement	Provides guide for interpretation
text		0..1	string	Provides guide for interpretation
hasMember		0..*	Reference(Observation)	Related resource that belongs to the Observation group
derivedFrom		0..1	Reference(Observation)	Related measurements the observation is made from
component		0..1	BackboneElement	Only supported for USCore pulse Oximetry profile Slice: Unordered, Open by value:component
component:All Slices				Content/Rules for all slices
code		0..1	CodeableConcept	Type of component observation (code / type)
coding		0..1	Coding	Code defined by a terminology system
value[x]		0..1	Quantity	Actual component result
dataAbsentReason		0..1	CodeableConcept	Why the component result is missing
component	S	1..*	BackboneElement	Travel location Slice: Unordered, Open by value:travelLocation
component:All Slices				Content/Rules for all slices
Slices for extension				Content/Rules for all slices
extension:ADDRESSEXTENSION		0..1	?gen-e1? [CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension]]	Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension"
value[x]		1..1	Address	Value of extension
code		0..1	CodeableConcept	Type of component observation (code / type) Slice: Unordered, Open by value:code
code:All Slices				Content/Rules for all slices
coding		0..1	Coding	Travel location code Slice: Unordered, Open by value:code.coding
value[x]		1..1	CodeableConcept	Actual component result
coding		1..*	Coding	contryCode coding
component	S	0..*	BackboneElement	occupationIndustryCode Slice: Unordered, Open by value:occupationIndustry
component:All Slices				Content/Rules for all slices
code		0..1	CodeableConcept	Type of component observation (code / type) Slice: Unordered, Open by value:code
code:All Slices				Content/Rules for all slices
coding		0..1	Coding	Code defined by a terminology system Slice: Unordered, Open by value:code.coding
value[x]		1..1	CodeableConcept	Actual component result
coding		1..*	Coding	Code defined by a terminology system
component	S	0..*	BackboneElement	Purpose of travel Slice: Unordered, Open by value:travelPurpose
component:All Slices				Content/Rules for all slices
code		0..1	CodeableConcept	Type of component observation (code / type) Slice: Unordered, Open by value:code
code:All Slices				Content/Rules for all slices
coding		0..1	Coding	Purpose of travel coding Slice: Unordered, Open by value:code.coding
value[x]		1..1	CodeableConcept	Actual component result
coding		1..*	Coding	Code defined by a terminology system
Documentation for this format

Snapshot View

Description & Constraints Filter: Filters

Observation

0..*

Observation

Measurements and simple assertions
Constraints: obs-6, obs-7

SΣ

0..1

Unique Id for this particular observation

Terminology Bindings

Path Conformance ValueSet URI

Observation.meta.security

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

From the FHIR Standard

Observation.meta.security:SENSITIVECHART

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

From the FHIR Standard

Observation.meta.security:CONFABBR

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

From the FHIR Standard

Observation.meta.tag

example

CommonTags

http://hl7.org/fhir/ValueSet/common-tags

From the FHIR Standard

Observation.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

From the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Observation.status

required

ObservationStatus

http://hl7.org/fhir/ValueSet/observation-status|4.0.1

From the FHIR Standard

Observation.category

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.category:FHIRCATEGORY

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.category:PANELCATEGORY

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.category:HG_GROUPID

preferred

ObservationCategoryCodes

http://hl7.org/fhir/ValueSet/observation-category

From the FHIR Standard

Observation.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.bodySite

example

SNOMEDCTBodyStructures

http://hl7.org/fhir/ValueSet/body-site

From the FHIR Standard

Observation.method

example

ObservationMethods

http://hl7.org/fhir/ValueSet/observation-methods

From the FHIR Standard

Observation.referenceRange.type

preferred

ObservationReferenceRangeMeaningCodes

http://hl7.org/fhir/ValueSet/referencerange-meaning

From the FHIR Standard

Observation.referenceRange.appliesTo

example

ObservationReferenceRangeAppliesToCodes

http://hl7.org/fhir/ValueSet/referencerange-appliesto

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Observation.component.code

example

LOINCCodes(a valid code from LOINC)

http://hl7.org/fhir/ValueSet/observation-codes

From the FHIR Standard

Observation.component.dataAbsentReason

extensible

DataAbsentReason

http://hl7.org/fhir/ValueSet/data-absent-reason

From the FHIR Standard

Observation.component.interpretation

extensible

ObservationInterpretationCodes

http://hl7.org/fhir/ValueSet/observation-interpretation

From the FHIR Standard

Constraints

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-3	error	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.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 Observation

Summary

Mandatory: 7 elements(13 nested mandatory elements)
Must-Support: 14 elements
Fixed: 3 elements

Extensions

This structure refers to these extensions:

Unable to summarise extension https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile-obstypen-exactcodedescription (no extension found)
Unable to summarise extension http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension (no extension found)

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of Observation.meta.profile
The element 1 is sliced based on the value of Observation.meta.security
The element 1 is sliced based on the value of Observation.category
The element 1 is sliced based on the value of Observation.code.coding
The element 1 is sliced based on the value of Observation.performer
The element 1 is sliced based on the value of Observation.component
The element 1 is sliced based on the value of Observation.component.code
The element 1 is sliced based on the value of Observation.component.code.coding

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Observation resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Observation?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name	Description
[base]	Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count]	Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Observation resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format]	Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary]	Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token)	The ID of the resource
_security (token)	Search by a security label
_tag (token)	Search by a resource tag
_lastUpdated (date)
_lastUpdated-fromnow (quantity)	Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7\|\|d for more than seven days in the future or =le-2\|\|mo for less than two months in the past. The unit must be specified.
category (token)	The classification of the type of observation
code (token)	The code of the observation type
combo-code (token)	The code of the observation type or component type
combo-value-concept (token)	The value or component value of the observation, if the value is a CodeableConcept
combo-value-quantity (quantity)	Code and quantity value parameter pair, including in components
component-code (token)	The component code of the observation type
component-value-quantity (quantity)	The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
date (date)	Obtained date/time. If the obtained element is a period, a date that falls in the period
date-fromnow (quantity)	Like date except expressed as a positive or negative offset from the current time in units of time, e.g. occurrence-fromnow=ge7\|\|d for more than seven days in the future or =le-2\|\|mo for less than two months in the past. The unit must be specified.
encounter (reference)	Encounter related to the observation
identifier (token)	The unique id for a particular observation
patient (reference)	The subject that the observation is about (if patient)
performer (reference)	Who performed the observation
status (token)	The status of the observation
subject (reference)	The subject that the observation is about
value-concept (token)	The value of the observation, if the value is a CodeableConcept
value-quantity (quantity)	The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
_recent (quantity)	Specifies the number of most recent (latest) results to return for each matching observation term. The value must be a positive integer. e.g. _recent=1 to request only the single most recent value for each type of observation (OBS term).

Name

Description

[base]

Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer

[_count]

Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Observation resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.

[_format]

Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.

[_summary]

Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.

_id (token)

The ID of the resource

_security (token)

Search by a security label

_tag (token)

Search by a resource tag

_lastUpdated (date)

_lastUpdated-fromnow (quantity)

Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.

category (token)

The classification of the type of observation

code (token)

The code of the observation type

combo-code (token)

The code of the observation type or component type

combo-value-concept (token)

The value or component value of the observation, if the value is a CodeableConcept

combo-value-quantity (quantity)

Code and quantity value parameter pair, including in components

component-code (token)

The component code of the observation type

component-value-quantity (quantity)

The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

date (date)

Obtained date/time. If the obtained element is a period, a date that falls in the period

date-fromnow (quantity)

Like date except expressed as a positive or negative offset from the current time in units of time, e.g. occurrence-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.

encounter (reference)

Encounter related to the observation

identifier (token)

The unique id for a particular observation

patient (reference)

The subject that the observation is about (if patient)

performer (reference)

Who performed the observation

status (token)

The status of the observation

subject (reference)

The subject that the observation is about

value-concept (token)

The value of the observation, if the value is a CodeableConcept

value-quantity (quantity)

The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

_recent (quantity)

Specifies the number of most recent (latest) results to return for each matching observation term. The value must be a positive integer. e.g. _recent=1 to request only the single most recent value for each type of observation (OBS term).

HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK

The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.

401 Unauthorized

Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.

500 Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.