observation definitions

Create Observation Definition

post
/organizations/{organizationId}/fhir/4/ObservationDefinition

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ObservationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
categoryarray(CodeableConcept)A code that classifies the general type of observation.
code*CodeableConceptDescribes what will be observed. Sometimes this is called the observation "name".
identifierarray(Identifier)A unique identifier assigned to this ObservationDefinition artifact.
permittedDataTypearray()The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
multipleResultsAllowedbooleanMultiple results allowed for observations conforming to this ObservationDefinition.
methodCodeableConceptThe method or technique used to perform the observation.
preferredReportNamestringThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
quantitativeDetailsObservationDefinition_QuantitativeDetailsCharacteristics for quantitative results of this observation.
qualifiedIntervalarray(ObservationDefinition_QualifiedInterval)Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
validCodedValueSetReferenceThe set of valid coded results for the observations conforming to this ObservationDefinition.
normalCodedValueSetReferenceThe set of normal coded results for the observations conforming to this ObservationDefinition.
abnormalCodedValueSetReferenceThe set of abnormal coded results for the observation conforming to this ObservationDefinition.
criticalCodedValueSetReferenceThe set of critical coded results for the observation conforming to this ObservationDefinition.

Response

Patch Observation Definition

patch
/organizations/{organizationId}/fhir/4/ObservationDefinition/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a ObservationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
categoryarray(CodeableConcept)A code that classifies the general type of observation.
code*CodeableConceptDescribes what will be observed. Sometimes this is called the observation "name".
identifierarray(Identifier)A unique identifier assigned to this ObservationDefinition artifact.
permittedDataTypearray()The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
multipleResultsAllowedbooleanMultiple results allowed for observations conforming to this ObservationDefinition.
methodCodeableConceptThe method or technique used to perform the observation.
preferredReportNamestringThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
quantitativeDetailsObservationDefinition_QuantitativeDetailsCharacteristics for quantitative results of this observation.
qualifiedIntervalarray(ObservationDefinition_QualifiedInterval)Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
validCodedValueSetReferenceThe set of valid coded results for the observations conforming to this ObservationDefinition.
normalCodedValueSetReferenceThe set of normal coded results for the observations conforming to this ObservationDefinition.
abnormalCodedValueSetReferenceThe set of abnormal coded results for the observation conforming to this ObservationDefinition.
criticalCodedValueSetReferenceThe set of critical coded results for the observation conforming to this ObservationDefinition.

Response

Read Observation Definition

get
/organizations/{organizationId}/fhir/4/ObservationDefinition/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Observation Definition

get
/organizations/{organizationId}/fhir/4/ObservationDefinition/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Observation Definition

get
/organizations/{organizationId}/fhir/4/ObservationDefinition/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Observation Definition

delete
/organizations/{organizationId}/fhir/4/ObservationDefinition/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Observation Definition

get
/organizations/{organizationId}/fhir/4/ObservationDefinition

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring

Params

organizationId*string|stringid|slug

Response

Search History Observation Definition

get
/organizations/{organizationId}/fhir/4/ObservationDefinition/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Observation Definition

post
/organizations/{organizationId}/fhir/4/ObservationDefinition/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ObservationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
categoryarray(CodeableConcept)A code that classifies the general type of observation.
code*CodeableConceptDescribes what will be observed. Sometimes this is called the observation "name".
identifierarray(Identifier)A unique identifier assigned to this ObservationDefinition artifact.
permittedDataTypearray()The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
multipleResultsAllowedbooleanMultiple results allowed for observations conforming to this ObservationDefinition.
methodCodeableConceptThe method or technique used to perform the observation.
preferredReportNamestringThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
quantitativeDetailsObservationDefinition_QuantitativeDetailsCharacteristics for quantitative results of this observation.
qualifiedIntervalarray(ObservationDefinition_QualifiedInterval)Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
validCodedValueSetReferenceThe set of valid coded results for the observations conforming to this ObservationDefinition.
normalCodedValueSetReferenceThe set of normal coded results for the observations conforming to this ObservationDefinition.
abnormalCodedValueSetReferenceThe set of abnormal coded results for the observation conforming to this ObservationDefinition.
criticalCodedValueSetReferenceThe set of critical coded results for the observation conforming to this ObservationDefinition.

Response

Update Observation Definition

put
/organizations/{organizationId}/fhir/4/ObservationDefinition/{resourceId}

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a ObservationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
categoryarray(CodeableConcept)A code that classifies the general type of observation.
code*CodeableConceptDescribes what will be observed. Sometimes this is called the observation "name".
identifierarray(Identifier)A unique identifier assigned to this ObservationDefinition artifact.
permittedDataTypearray()The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
multipleResultsAllowedbooleanMultiple results allowed for observations conforming to this ObservationDefinition.
methodCodeableConceptThe method or technique used to perform the observation.
preferredReportNamestringThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
quantitativeDetailsObservationDefinition_QuantitativeDetailsCharacteristics for quantitative results of this observation.
qualifiedIntervalarray(ObservationDefinition_QualifiedInterval)Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
validCodedValueSetReferenceThe set of valid coded results for the observations conforming to this ObservationDefinition.
normalCodedValueSetReferenceThe set of normal coded results for the observations conforming to this ObservationDefinition.
abnormalCodedValueSetReferenceThe set of abnormal coded results for the observation conforming to this ObservationDefinition.
criticalCodedValueSetReferenceThe set of critical coded results for the observation conforming to this ObservationDefinition.

Response