Observation_GET

GET {{baseUrl}}/Observation?patient=<string>&encounter=<string>&based-on=<string>&context=<string>&device=<string>&performer=<string>&related-target=<string>&specimen=<string>&subject=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&code=<string>&date=<date>&identifier=<string>&category=<string>&code-value-concept=<string>&code-value-date=<string>&code-value-quantity=<string>&code-value-string=<string>&combo-code=<string>&combo-code-value-concept=<string>&combo-code-value-quantity=<string>&combo-data-absent-reason=<string>&combo-value-concept=<string>&combo-value-quantity=<integer>&component-code=<string>&component-code-value-concept=<string>&component-code-value-quantity=<string>&component-data-absent-reason=<string>&component-value-concept=<string>&component-value-quantity=<integer>&data-absent-reason=<string>&method=<string>&related=<string>&related-type=<string>&status=<string>&value-concept=<string>&value-date=<date>&value-quantity=<integer>&value-string=<string>&_format=<string>

Request Params

KeyDatatypeRequiredDescription
patientstringMultiple Resources:
  • ReferralRequest: Who the referral is about

  • DocumentManifest: The subject of the set of documents

  • Goal: Who this goal is intended for

  • Consent: Who the consent applies to

  • DocumentReference: Who/what is the subject of the document

  • ImagingManifest: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)

  • RiskAssessment: Who/what does assessment apply to?

  • CareTeam: Who care team is for

  • ImagingStudy: Who the study is about

  • FamilyMemberHistory: The identity of a subject to list family member history items for

  • Encounter: The patient ro group present at the encounter

  • DeviceUseStatement: Search by subject - a patient

  • DeviceRequest: Individual the service is ordered for

  • AllergyIntolerance: Who the sensitivity is for

  • CarePlan: Who care plan is for

  • EpisodeOfCare: The patient who is the focus of this episode of care

  • Procedure: Search by subject - a patient

  • List: If all resources have the same subject

  • Immunization: The patient for the vaccination record

  • VisionPrescription: The identity of a patient to list dispenses for

  • ProcedureRequest: Search by subject - a patient

  • Flag: The identity of a subject to list flags for

  • Observation: The subject that the observation is about (if patient)

  • DiagnosticReport: The subject of the report if a patient

  • NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement

  • Condition: Who has the condition?

  • Composition: Who and/or what the composition is about

  • DetectedIssue: Associated patient

  • SupplyDelivery: Patient for whom the item is supplied

  • ClinicalImpression: Patient or group assessed | | encounter | string | | Multiple Resources:

  • DocumentReference: Context of the document content

  • RiskAssessment: Where was assessment performed?

  • DeviceRequest: Encounter or Episode during which request was created

  • Procedure: Search by encounter

  • List: Context in which list created

  • VisionPrescription: Return prescriptions with this encounter identifier

  • ProcedureRequest: An encounter in which this request is made

  • Flag: Alert relevant during encounter

  • Observation: Encounter related to the observation

  • DiagnosticReport: The Encounter when the order was made

  • NutritionOrder: Return nutrition orders with this encounter identifier

  • Composition: Context of the Composition | | based-on | string | | Reference to the test or procedure request. | | context | string | | Healthcare event (Episode-of-care or Encounter) related to the observation | | device | string | | The Device that generated the observation data. | | performer | string | | Who performed the observation | | related-target | string | | Resource that is related to this one | | specimen | string | | Specimen used for this observation | | subject | string | | The subject that the observation is about | | _id | string | | Logical id of this artifact | | _lastUpdated | string | | When the resource version last changed | | _profile | string | | Profiles this resource claims to conform to | | _security | string | | Security Labels applied to this resource | | _tag | string | | Tags applied to this resource | | code | string | | Multiple Resources:

  • FamilyMemberHistory: A search by a condition code

  • DeviceRequest: Code for what is being requested/ordered

  • AllergyIntolerance: Code that identifies the allergy or intolerance

  • Procedure: A code to identify a procedure

  • List: What the purpose of this list is

  • ProcedureRequest: What is being requested/ordered

  • Observation: The code of the observation type

  • DiagnosticReport: The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result

  • Condition: Code for the condition | | date | string | | Multiple Resources:

  • Consent: When this Consent was created or indexed

  • SupplyRequest: When the request was made

  • RiskAssessment: When was assessment made?

  • CareTeam: Time period team covers

  • FamilyMemberHistory: When history was captured/updated

  • Encounter: A date within the period the Encounter lasted

  • AllergyIntolerance: Date record was believed accurate

  • CarePlan: Time period plan covers

  • EpisodeOfCare: The provided date search value falls within the episode of care's period

  • Procedure: Date/Period the procedure was performed

  • List: When the list was prepared

  • Immunization: Vaccination (non)-Administration Date

  • Flag: Time period when flag is active

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

  • DiagnosticReport: The clinically relevant time of the report

  • Composition: Composition editing time

  • DetectedIssue: When identified

  • ClinicalImpression: When the assessment was documented | | identifier | string | | Multiple Resources:

  • DocumentManifest: Unique Identifier for the set of documents

  • Goal: External Ids for this goal

  • Consent: Identifier for this record (external references)

  • DocumentReference: Master Version Specific Identifier

  • SupplyRequest: Unique identifier

  • RiskAssessment: Unique identifier for the assessment

  • CareTeam: External Ids for this team

  • ImagingStudy: Other identifiers for the Study

  • FamilyMemberHistory: A search by a record identifier

  • Encounter: Identifier(s) by which this encounter is known

  • DeviceRequest: Business identifier for request/order

  • AllergyIntolerance: External ids for this item

  • CarePlan: External Ids for this plan

  • EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare

  • Procedure: A unique identifier for a procedure

  • List: Business identifier

  • Immunization: Business identifier

  • VisionPrescription: Return prescriptions with this external identifier

  • ProcedureRequest: Identifiers assigned to this order

  • Observation: The unique id for a particular observation

  • DiagnosticReport: An identifier for the report

  • NutritionOrder: Return nutrition orders with this external identifier

  • Condition: A unique identifier of the condition record

  • Composition: Logical identifier of composition (version-independent)

  • DetectedIssue: Unique id for the detected issue

  • SupplyDelivery: External identifier | | category | string | | The classification of the type of observation | | code-value-concept | string | | Code and coded value parameter pair | | code-value-date | string | | Code and date/time value parameter pair | | code-value-quantity | string | | Code and quantity value parameter pair | | code-value-string | string | | Code and string value parameter pair | | combo-code | string | | The code of the observation type or component type | | combo-code-value-concept | string | | Code and coded value parameter pair, including in components | | combo-code-value-quantity | string | | Code and quantity value parameter pair, including in components | | combo-data-absent-reason | string | | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | | combo-value-concept | string | | The value or component value of the observation, if the value is a CodeableConcept | | combo-value-quantity | string | | 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) | | component-code | string | | The component code of the observation type | | component-code-value-concept | string | | Component code and component coded value parameter pair | | component-code-value-quantity | string | | Component code and component quantity value parameter pair | | component-data-absent-reason | string | | The reason why the expected value in the element Observation.component.value[x] is missing. | | component-value-concept | string | | The value of the component observation, if the value is a CodeableConcept | | component-value-quantity | string | | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | | data-absent-reason | string | | The reason why the expected value in the element Observation.value[x] is missing. | | method | string | | The method used for the observation | | related | string | | Related Observations - search on related-type and related-target together | | related-type | string | | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by | | status | string | | The status of the observation | | value-concept | string | | The value of the observation, if the value is a CodeableConcept | | value-date | string | | The value of the observation, if the value is a date or period of time | | value-quantity | string | | 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) | | value-string | string | | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | | _format | string | | |

RESPONSES

status: OK

[{&quot;resourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;div&quot;:&quot;\u003cstring\u003e&quot;},&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;category&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;code&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;,&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;_display&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;]}}]},&quot;subject&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;},&quot;encounter&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;},&quot;effectiveDateTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;valueQuantity&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;unit&quot;:&quot;\u003cstring\u003e&quot;,&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;resourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;text&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;div&quot;:&quot;\u003cstring\u003e&quot;},&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;category&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;}]},&quot;code&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;coding&quot;:[{&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;display&quot;:&quot;\u003cstring\u003e&quot;,&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;_display&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;]}}]},&quot;subject&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;},&quot;encounter&quot;:{&quot;reference&quot;:&quot;\u003cstring\u003e&quot;},&quot;effectiveDateTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;valueQuantity&quot;:{&quot;fhir_comments&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;value&quot;:&quot;\u003cnumber\u003e&quot;,&quot;unit&quot;:&quot;\u003cstring\u003e&quot;,&quot;system&quot;:&quot;\u003cstring\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;}}]