bodyStructure.search

Native Request Elements

Name	Description	Required	Is Array	Types
id (String)	The FHIR ID.	✓	false	string
location (String)	Limits the search to a particular organ location. Format: "http://snomed.info/sct\\|SNOMEDCODE" where SNOMEDCODE is the numeric portion of the code associated with a particular body structure. For example, enter "http://snomed.info/sct\\|18639004" to search for left kidney structures. May send multiple entries separated by commas.	✓	false	string
morphology (String)	Limits the search to all organs, or to specifically donor or recipient organs. Enter "organs" for all organs, "http://snomed.info/sct\\|91723000" for donor organs, or "http://snomed.info/sct\\|280115004" for recipient organs.	✓	false	string
patient (String)	The patient for which to perform the search.		false	string
subject (String)	The patient for which to perform the search.		false	string

Response

{
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://hostname/instance/api/FHIR/R4/DocumentReference?encounter=ewjLq6T8jD2jClb0dkMYS25HM0BGjl-uE31HHZUSdadw3&category=clinical-reference"
        }
    ],
    "entry": [
        {
            "link": [
                {
                    "relation": "self",
                    "url": "https://hostname/instance/api/FHIR/R4/DocumentReference/eGlGqhMrWY-D7S9UWdHMuOoeJ0ive0Yvo0ssmqFUSohM3"
                }
            ],
            "fullUrl": "https://hostname/instance/api/FHIR/R4/DocumentReference/eGlGqhMrWY-D7S9UWdHMuOoeJ0ive0Yvo0ssmqFUSohM3",
            "resource": {
                "resourceType": "DocumentReference",
                "id": "eGlGqhMrWY-D7S9UWdHMuOoeJ0ive0Yvo0ssmqFUSohM3",
                "status": "current",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://open.epic.com/FHIR/StructureDefinition/documentreference-category",
                                "code": "clinical-reference",
                                "display": "Clinical Reference"
                            }
                        ],
                        "text": "Clinical Reference"
                    }
                ],
                "subject": {
                    "reference": "Patient/efS7U8khObcJM43siqMrZQ8qh4zBvSjftUk5VQhXXWGg3",
                    "display": "Brauwer, Alistair"
                },
                "date": "2022-01-28T16:16:47Z",
                "content": [
                    {
                        "attachment": {
                            "contentType": "text/rtf",
                            "url": "Binary/eg5G4a1wX1DGzkjxib3xh8P4.xnlTsrlTE0Ij6k6EDfw3"
                        },
                        "format": {
                            "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
                            "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                            "display": "mimeType Sufficient"
                        }
                    }
                ],
                "context": {
                    "encounter": [
                        {
                            "reference": "Encounter/ewjLq6T8jD2jClb0dkMYS25HM0BGjl-uE31HHZUSdadw3",
                            "identifier": {
                                "use": "usual",
                                "system": "urn:oid:1.2.840.114350.1.13.5325.1.7.3.698084.8",
                                "value": "10003900569"
                            },
                            "display": "Hospital Encounter"
                        }
                    ]
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}

bodyStructure.search

Native Request Elements

Response

On this page