Observation

Observation returns information about a parameter result.

Query

Endpoint

GET <serveraddress>/fhir/Observation

Parameter

Parameter	Query example	Description
id	<endpoint>/<id>	the technical id of the parameter

Examples

String parameter

{
    "resourceType": "Observation",
    "id": "observation-example-string",
    "contained":  [
        {
            "resourceType": "Practitioner",
            "id": "practitioner-example",
            "name":  [
                {
                    "family": "Meier",
                    "given":  [
                        "Hans"
                    ]
                }
            ]
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "code": "PARAMETER-1",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observations",
                "display": "Parameter 1"
            }
        ]
    },
    "effectiveDateTime": "2023-07-01T12:00:00+00:00",
    "issued": "2023-07-01T12:00:00+00:00",
    "performer":  [
        {
            "reference": "#practitioner-example"
        }
    ],
    "valueString": "This is a test.",
    "specimen": {
        "reference": "Specimen/specimen-example",
        "identifier": {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    }
}

Quantity (integer, decimal) parameter

{
    "resourceType": "Observation",
    "id": "observation-example-quantity",
    "contained":  [
        {
            "resourceType": "Practitioner",
            "id": "practitioner-example",
            "name":  [
                {
                    "family": "Meier",
                    "given":  [
                        "Hans"
                    ]
                }
            ]
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "code": "PARAMETER-2",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observations",
                "display": "Parameter 2"
            }
        ]
    },
    "effectiveDateTime": "2023-07-01T12:00:00+00:00",
    "issued": "2023-07-01T12:00:00+00:00",
    "performer":  [
        {
            "reference": "#practitioner-example"
        }
    ],
    "valueQuantity": {
        "value": 1,
        "code": "mg",
        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/units",
        "unit": "Milligramm"
    },
    "specimen": {
        "reference": "Specimen/specimen-example",
        "identifier": {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    }
}

Boolean parameter

{
    "resourceType": "Observation",
    "id": "observation-example-boolean",
    "contained":  [
        {
            "resourceType": "Practitioner",
            "id": "practitioner-example",
            "name":  [
                {
                    "family": "Meier",
                    "given":  [
                        "Hans"
                    ]
                }
            ]
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "code": "PARAMETER-3",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observations",
                "display": "Parameter 3"
            }
        ]
    },
    "effectiveDateTime": "2023-07-01T12:00:00+00:00",
    "issued": "2023-07-01T12:00:00+00:00",
    "performer":  [
        {
            "reference": "#practitioner-example"
        }
    ],
    "valueBoolean": true,
    "specimen": {
        "reference": "Specimen/specimen-example",
        "identifier": {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    }
}

File Parameter

{
    "resourceType": "Observation",
    "id": "observation-example-file",
    "contained":  [
        {
            "resourceType": "Practitioner",
            "id": "practitioner-example",
            "name":  [
                {
                    "family": "Meier",
                    "given":  [
                        "Hans"
                    ]
                }
            ]
        }
    ],
    "extension":  [
        {
            "url": "http://hl7.org/fhir/uv/v2mappings/StructureDefinition/value-attachment",
            "valueAttachment": {
                "contentType": "text/plain",
                "url": "Binary/binary-example",
                "size": 18,
                "title": "File.txt",
                "creation": "2023-07-01T12:00:00+00:00"
            }
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "code": "PARAMETER-4",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observations",
                "display": "Parameter 4"
            }
        ]
    },
    "effectiveDateTime": "2023-07-01T12:00:00+00:00",
    "issued": "2023-07-01T12:00:00+00:00",
    "performer":  [
        {
            "reference": "#practitioner-example"
        }
    ],
    "specimen": {
        "reference": "Specimen/specimen-example",
        "identifier": {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    }
}

Catalog parameter

{
    "resourceType": "Observation",
    "id": "observation-example-catalog",
    "contained":  [
        {
            "resourceType": "Practitioner",
            "id": "practitioner-example",
            "name":  [
                {
                    "family": "Meier",
                    "given":  [
                        "Hans"
                    ]
                }
            ]
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "code": "PARAMETER-5",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observations",
                "display": "Parameter 5"
            }
        ]
    },
    "effectiveDateTime": "2023-07-01T12:00:00+00:00",
    "issued": "2023-07-01T12:00:00+00:00",
    "performer":  [
        {
            "reference": "#practitioner-example"
        }
    ],
    "valueCodeableConcept": {
        "coding":  [
            {
                "code": "ZELLPOPULATION-1",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/cellpopulations"
            }
        ]
    },
    "specimen": {
        "reference": "Specimen/specimen-example",
        "identifier": {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    }
}

Table parameter

{
    "resourceType": "Observation",
    "id": "observation-example-table",
    "contained":  [
        {
            "resourceType": "Observation",
            "id": "row1-example",
            "status": "final",
            "code": {
                "coding":  [
                    {
                        "code": "(table-row)",
                        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components"
                    }
                ]
            },
            "component":  [
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_1",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte1"
                            }
                        ]
                    },
                    "valueString": "This is a test in row 1."
                },
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_2",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte2"
                            }
                        ]
                    },
                    "valueQuantity": {
                        "value": 1
                    }
                },
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_3",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte3"
                            }
                        ]
                    },
                    "valueBoolean": true
                },
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_4",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte4"
                            }
                        ]
                    },
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "code": "ZELLPOPULATION-1",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/cellpopulations"
                            }
                        ]
                    }
                }
            ]
        },
        {
            "resourceType": "Observation",
            "id": "row2-example",
            "status": "final",
            "code": {
                "coding":  [
                    {
                        "code": "(table-row)",
                        "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components"
                    }
                ]
            },
            "component":  [
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_1",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte1"
                            }
                        ]
                    },
                    "valueString": "This is a test in row 2."
                },
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_2",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte2"
                            }
                        ]
                    },
                    "valueQuantity": {
                        "value": 2
                    }
                },
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_3",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte3"
                            }
                        ]
                    },
                    "valueBoolean": false
                },
                {
                    "code": {
                        "coding":  [
                            {
                                "code": "spalte_4",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observation-components",
                                "display": "Spalte4"
                            }
                        ]
                    },
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "code": "ZELLPOPULATION-2",
                                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/cellpopulations"
                            }
                        ]
                    }
                }
            ]
        },
        {
            "resourceType": "Practitioner",
            "id": "practitioner-example",
            "name":  [
                {
                    "family": "Meier",
                    "given":  [
                        "Hans"
                    ]
                }
            ]
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "code": "PARAMETER-6",
                "system": "http://www.qualitype.de/samples/fhir/CodeSystem/observations",
                "display": "Parameter 6"
            }
        ]
    },
    "effectiveDateTime": "2023-07-01T12:00:00+00:00",
    "issued": "2023-07-01T12:00:00+00:00",
    "performer":  [
        {
            "reference": "#practitioner-example"
        }
    ],
    "specimen": {
        "reference": "Specimen/specimen-example",
        "identifier": {
            "system": "http://www.acme.com/fhir/NamingSystem/specimen-identifier",
            "value": "sample-extern-123"
        }
    },
    "hasMember":  [
        {
            "reference": "#row1-example"
        },
        {
            "reference": "#row2-example"
        }
    ]
}