Clinical Diagnostics

GET Retrieves all observations

GET /Observation

Retrieves a set of resources by using filters.

Parameters

  • code (query, string) The code of the observation type.
  • patient (query, string) The subject that the observation is about if subject is a patient.
  • X-CORRELATION-ID (header, string)

Responses

  • 200

    Media type: application/fhir+json. Schema: ObservationBundle.

    Contains a collection of resources.

    • Rule: total only for search results or history.
    • Rule: entry.search only for a search request.
    • Rule: entry.request mandatory for batch, transaction, or history, else prohibited.
    • Rule: entry.response mandatory for batch-response, transaction-response, or history, else prohibited.
    • Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles).
    • Rule: A document must have an identifier with a system and a value.
    • Rule: A document must have a date.
    • Rule: A document must have a Composition resource as the first resource.
    • Rule: A message must have a MessageHeader resource as the first resource. Elements defined in Ancestors: id, meta, implicitRules, and language.

    Example

    {
        "resourceType": "Bundle",
        "id": "5410528a-15ed-45cc-b18a-fe87f65ca2b7",
        "meta": {
            "lastUpdated": "2023-08-08T10:03:38.569Z"
        },
        "type": "searchset",
        "total": 1,
        "link": [
            {
                "relation": "self",
                "url": "https://healthcloud.lb.anypointdns.net/clinical-diagnostics/fhir-r4/v1/Observation?code=http://loinc.org%7C57837-99&patient=001RO00000AzQZ9YAN"
            }
        ],
        "entry": [
            {
                "fullUrl": "https://healthcloud.lb.anypointdns.net/clinical-diagnostics/fhir-r4/v1/Observation/0hIRO00000006zf2AA",
                "search": {
                    "mode": "match"
                },
                "resource": {
                    "resourceType": "Observation",
                    "id": "0hIRO00000006zf2AA",
                    "name": "Observation Data",
                    "status": "final",
                    "category": [
                        {
                            "coding": [
                                {
                                    "code": "vital-sign",
                                    "system": "http://terminology.hl7.org/CodeSystem/observation-category"
                                }
                            ]
                        }
                    ],
                    "code": {
                        "coding": [
                            {
                                "system": "http://loinc.org",
                                "code": "57837-99",
                                "display": "Body weight"
                            }
                        ]
                    },
                    "subject": {
                        "reference": "Patient/001RO00000AzQZ9YAN"
                    },
                    "effectivePeriod": {
                        "start": "2008-07-17T23:23:00.000Z",
                        "end": "2009-07-17T23:23:00.000Z"
                    },
                    "issued": "2004-05-13T15:49:49.000Z",
                    "performer": [{
                        "reference": "Patient/001RO00000AzQZ9YAN",
                        "type": "Patient"
                    }],
                    "bodySite": {
                        "coding": [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "65904435",
                                "display": "Left external ear structure"
                            }
                        ],
                        "text": "Left external ear structure"
                    },
                    "interpretation": [
                        {
                            "coding": [
                                {
                                    "code": "468359832"
                                }
                            ]
                        }
                    ],
                    "method": {
                        "coding": [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "867859167",
                                "display": "Negative"
                            },
                            {
                                "system": "https://acme.lab/resultcodes",
                                "code": "KAG1",
                                "display": "Negative"
                            }
                        ],
                        "text": "Negative"
                    },
                    "referenceRange": [
                        {
                            "low": {
                                "value": 7.9
                            },
                            "high": {
                                "value": 72.95
                            },
                            "text": "Negative for Chlamydia Trachomatis rRNA"
                        }
                    ],
                    "component": [
                        {
                            "name": "Observatioon Component Data",
                            "code": {
                                "coding": [
                                    {
                                        "system": "http://loinc.org",
                                        "code": "745968-97",
                                        "display": "Body weight"
                                    }
                                ],
                                "text": "Body weight"
                            },
                            "dataAbsentReason": {
                                "coding": [
                                    {
                                        "code": "157183"
                                    }
                                ]
                            },
                            "interpretation": [
                                {
                                    "coding": [
                                        {
                                            "system": "http://snomed.info/sct",
                                            "code": "768976-09",
                                            "display": "Negative"
                                        },
                                        {
                                            "system": "https://acme.lab/resultcodes",
                                            "code": "DFG1",
                                            "display": "Negative"
                                        }
                                    ],
                                    "text": "Negative"
                                }
                            ],
                            "referenceRange": [
                                {
                                    "low": {
                                        "value": 7.81,
                                        "unit": "mm",
                                        "code": "mm[Hg]"
                                    },
                                    "high": {
                                        "value": 72.96,
                                        "unit": "mm",
                                        "code": "mm[Hg]"
                                    },
                                    "text": "Negative for Chlamydia Trachomatis rRNA"
                                }
                            ],
                            "valueQuantity": {
                                "value": 99.94,
                                "unit": "ratio",
                                "code": "ratio"
                            }
                        }
                    ],
                    "valueBoolean": "false"
                }
            }
        ]
    }
  • 503 There was an error connecting to Salesforce.

    Media type: application/fhir+json. Schema: OperationOutcome.

    Example

    {
        "resourceType": "OperationOutcome",
        "issue": [
            {
                "severity": "error",
                "code": "code-invalid",
                "details": {
                    "text": "DiagnosticReport details not found."
                }
            }
        ]
    }