Skip to main content

ObservationDefinition

Trial Use 1 Specialized — Quality & Testing

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/ObservationDefinition
InteractionMethodPath
ReadGET/fhir/R5/ObservationDefinition/[id]
VreadGET/fhir/R5/ObservationDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R5/ObservationDefinition/[id]
PatchPATCH/fhir/R5/ObservationDefinition/[id]
DeleteDELETE/fhir/R5/ObservationDefinition/[id]
CreatePOST/fhir/R5/ObservationDefinition
SearchGET/fhir/R5/ObservationDefinition?...
HistoryGET/fhir/R5/ObservationDefinition/[id]/_history
Type-historyGET/fhir/R5/ObservationDefinition/_history

Top-level elements

ElementType(s)CardinalityDescription
urluri0..1Logical canonical URL to reference this ObservationDefinition (globally unique)
identifierIdentifier0..1Business identifier of the ObservationDefinition
versionstring0..1Business version of the ObservationDefinition
versionAlgorithm[x]string / Coding0..1How to compare versions
namestring0..1Name for this ObservationDefinition (computer friendly)
titlestring0..1Name for this ObservationDefinition (human friendly)
statuscode1..1draft
experimentalboolean0..1If for testing purposes, not real usage
datedateTime0..1Date last changed
publisherstring0..1The name of the individual or organization that published the ObservationDefinition
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the ObservationDefinition
useContextUsageContext0..*Content intends to support these contexts
jurisdictionCodeableConcept0..*Intended jurisdiction for this ObservationDefinition (if applicable)
purposemarkdown0..1Why this ObservationDefinition is defined
copyrightmarkdown0..1Use and/or publishing restrictions
copyrightLabelstring0..1Copyright holder and year(s)
approvalDatedate0..1When ObservationDefinition was approved by publisher
lastReviewDatedate0..1Date on which the asset content was last reviewed by the publisher
effectivePeriodPeriod0..1The effective date range for the ObservationDefinition
derivedFromCanonicalcanonical0..*Based on FHIR definition of another observation
derivedFromUriuri0..*Based on external definition
subjectCodeableConcept0..*Type of subject for the defined observation
performerTypeCodeableConcept0..1Desired kind of performer for such kind of observation
categoryCodeableConcept0..*General type of observation
codeCodeableConcept1..1Type of observation
permittedDataTypecode0..*Quantity
multipleResultsAllowedboolean0..1Multiple results allowed for conforming observations
bodySiteCodeableConcept0..1Body part to be observed
methodCodeableConcept0..1Method used to produce the observation
specimenReference0..*Kind of specimen used by this type of observation
deviceReference0..*Measurement device or model of device
preferredReportNamestring0..1The preferred name to be used when reporting the observation results
permittedUnitCoding0..*Unit for quantitative results
qualifiedValueBackboneElement0..*Set of qualified values for observation results
hasMemberReference0..*Definitions of related resources belonging to this kind of observation group
componentBackboneElement0..*Component results

Resource-specific search parameters

ParameterTypeDescription
categorytokenCategory (class) of observation
codetokenObservation code
experimentaltokenNot for genuine usage (true)
identifiertokenExternal identifier for the activity definition
methodtokenMethod of observation
statustokenThe current status of the activity definition
titlestringThe human-friendly name of the activity definition
urluriThe uri that identifies the activity definition

Reference