Elekta FHIR API

AllergyIntolerance

readAllergyIntolerance

read: Read a FHIR AllergyIntolerance

/AllergyIntolerance/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /AllergyIntolerance/9e51657c-1bd0-4117-a19c-bf0e0beaa004

searchAllergyIntoleranceGet

search-type: Search for AllergyIntolerance by Patient and Category

/AllergyIntolerance?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
Who the sensitivity is for
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /AllergyIntolerance?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for AllergyIntolerance by Patient and Clinical Status

/AllergyIntolerance?patient=[patient]&clinical-status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who the sensitivity is for
Required
clinical-status
String
active | inactive | resolved
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /AllergyIntolerance?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&clinical-status=active

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T19:01:16.658+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T19:01:16.658+00:00",
        "versionId": "2c35bf54-f4cd-40f7-963d-5f1d5c5a8b26"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/AllergyIntolerance/9e51657c-1bd0-4117-a19c-bf0e0beaa004",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "AllergyIntolerance",
                "id": "9e51657c-1bd0-4117-a19c-bf0e0beaa004",
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                            "code": "entered-in-error",
                            "display": "Entered in Error"
                        }
                    ]
                },
                "code": {
                    "coding": [
                        {
                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                            "code": "733",
                            "display": "ampicillin"
                        }
                    ]
                },
                "patient": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "onsetDateTime": "1980-05-10T00:00:00-06:00",
                "meta": {
                    "versionId": "c4698243-8b3b-4e85-b932-359dc6516bd8",
                    "lastUpdated": "2022-10-26T18:48:20.064+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/AllergyIntolerance/ae077803-f128-4160-9e5c-1587af1cbfcc",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "AllergyIntolerance",
                "id": "ae077803-f128-4160-9e5c-1587af1cbfcc",
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ]
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ]
                },
                "code": {
                    "coding": [
                        {
                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                            "code": "733",
                            "display": "ampicillin"
                        }
                    ]
                },
                "patient": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "onsetDateTime": "1980-05-10T00:00:00-06:00",
                "meta": {
                    "versionId": "5d89841f-dc5e-48b4-8c9b-750482716169",
                    "lastUpdated": "2022-10-26T18:48:19.263+00:00"
                }
            }
        }
    ],
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/AllergyIntolerance?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "2460959e-4588-4518-8b9c-ae71fe6c4d4d"
}
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Binary

readBinary

read: Read a FHIR Binary

/Binary/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Binary/a79e61e5-f440-48c2-81b3-0ca34ba6f99e-1

Responses

Status: 200 - Success


{
  "resourceType": "Binary",
	"id": "a79e61e5-f440-48c2-81b3-0ca34ba6f99e-1",
	"contentType": "application/msword",
	"data": "{{content here}}"
}
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

CarePlan

readCarePlan

read: Read a FHIR CarePlan

/CarePlan/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /CarePlan/8f61f128-ee82-4b0a-84b2-18852c9c52ec

searchCarePlanGet

search-type: Search for CarePlan by Patient and Category

/CarePlan?patient=[patient]&category={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who the care plan is for
Required
category*
String
Type of plan
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /CarePlan?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=assess-plan

search-type: Search for CarePlan by Patient, Category and Status

/CarePlan?patient=[patient]&category={system|}[code]&status=[status]

Parameters

Query parameters
Name Description
patient*
String
Who the care plan is for
Required
category*
String
Type of plan
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /CarePlan?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=assess-plan&status=draft

search-type: Search for CarePlan by Patient, Category and Date

/CarePlan?patient=[patient]&category={system|}[code]&date=[date]

Parameters

Query parameters
Name Description
patient*
String
Who the care plan is for
Required
category*
String
Type of plan
Required
date*
String
Time period plan covers
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /CarePlan?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=assess-plan&date=ge2001-01-01

search-type: Search for CarePlan by Patient, Category, Status and Date

/CarePlan?patient=[patient]&category={system|}[code]&status=[status]&date=[date]

Parameters

Query parameters
Name Description
patient*
String
Who the care plan is for
Required
category*
String
Type of plan
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
date*
String
Time period plan covers
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /CarePlan?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=assess-plan&status=draft&date=ge2001-01-01

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T19:01:36.772+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T19:01:36.772+00:00",
        "versionId": "92be1d3a-47b0-481c-b368-1c10052524c0"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/CarePlan/8f61f128-ee82-4b0a-84b2-18852c9c52ec",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "CarePlan",
                "id": "8f61f128-ee82-4b0a-84b2-18852c9c52ec",
                "text": {
                    "status": "additional",
					"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Assessment</b></p><p>Date: 6/22/2015 10:00:00 AM</p><p class=\"justify\">Assessment: The patient was found to have fever and Dr Davis is suspecting Anemia based on the patient history.  So Dr Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health Hospitals if the fever does not subside within a day.\r\n\r\nPlan of Treatment\r\ni. Get an EKG done on 6/23/2015\r\nii. Get a Chest X-ray done on 6/23/2015 showing the Lower Respiratory Tract Structure\r\niii. Take Clindamycin 300mg three times a day as needed if pain does not subside\r\niv. Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015</p></div>"
                },
                "status": "entered-in-error",
                "intent": "plan",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                                "code": "assess-plan"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "meta": {
                    "versionId": "19dd6446-d3da-4dbd-a1ba-83a9e099d2b4",
                    "lastUpdated": "2022-10-26T18:49:51.539+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/CarePlan/f75428b2-c57e-4a3b-9951-9caad0115ff4",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "CarePlan",
                "id": "f75428b2-c57e-4a3b-9951-9caad0115ff4",
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Assessment</b></p><p>Date: 6/22/2015 3:00:00 PM</p><p class=\"justify\">The patient was found to have fever and Dr. Davis is suspecting Anemia based on patient history.  So Dr. Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health Hospitals if the fever does not subside within a day.</p></div>"
                },
                "status": "draft",
                "intent": "plan",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                                "code": "assess-plan"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "meta": {
                    "versionId": "ec39f13f-83ae-49f4-b65a-6204f3ef5108",
                    "lastUpdated": "2022-10-26T18:49:49.635+00:00"
                }
            }
        }
    ],
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/CarePlan?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "83ceed58-dece-4e0c-94e5-3c66663b3d92"
}
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

CareTeam

readCareTeam

read: Read a FHIR CareTeam

/CareTeam/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /CareTeam/CT-48235650-e0bf-43f6-a790-f322b3b0f8ff

searchCareTeamGet

search-type: Search for CareTeam by Patient and Status

/CareTeam?patient=[patient]&status=[status]

Parameters

Query parameters
Name Description
patient*
String
Who care team is for
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /CareTeam?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&status=active

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-23T18:48:28.783+00:00",
    "meta": {
        "lastUpdated": "2022-11-23T18:48:28.783+00:00",
        "versionId": "3ae1362b-fa55-4f52-bf81-8695f36cc208"
    },
    "entry": [
        {
            "fullUrl": "https://firely01elektacert.azurewebsites.net/CareTeam/CT-48235650-e0bf-43f6-a790-f322b3b0f8ff",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "CareTeam",
                "id": "CT-48235650-e0bf-43f6-a790-f322b3b0f8ff",
                "status": "active",
                "subject": {
                    "reference": "https://firely01elektacert.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "participant": [
                    {
                        "role": [
                            {
                                "coding": [
                                    {
                                        "system": "http://snomed.info/sct",
                                        "code": "405279007",
                                        "display": "Attending physician"
                                    }
                                ]
                            }
                        ],
                        "member": {
                            "reference": "https://firely01elektacert.azurewebsites.net/Practitioner/a320ba5e-265c-4a69-bfff-af0aea645bab",
                            "display": "Davis, Albert"
                        }
                    },
                    {
                        "role": [
                            {
                                "text": "Nurse"
                            }
                        ],
                        "member": {
                            "reference": "https://firely01elektacert.azurewebsites.net/Practitioner/90f56f20-e7b4-407a-b0a3-2e5ff2c76445",
                            "display": "Davis, Tracy"
                        }
                    },
                    {
                        "role": [
                            {
                                "text": "Organization"
                            }
                        ],
                        "member": {
                            "reference": "https://firely01elektacert.azurewebsites.net/Organization/5c4a9fbf-28bb-4d8f-b5b0-6448857e2e17",
                            "display": "Sunnyvale Radiation Oncology"
                        }
                    }
                ],
                "meta": {
                    "versionId": "d728bee0-ed61-4d6b-b3bd-3b46c8050a88",
                    "lastUpdated": "2022-11-18T23:03:41.198+00:00"
                }
            }
        }
    ],
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01elektacert.azurewebsites.net/CareTeam?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "261717f1-1367-485f-8ff5-a6053307cdd1"
}
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Condition

readCondition

read: Read a FHIR Condition

/Condition/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Condition/8a347be9-cff4-4f10-86ea-dff590265c42

searchConditionGet

search-type: Search for Condition by Patient

/Condition?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
Who has the condition?
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Condition?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Condition by Patient and Clinical Status

/Condition?patient=[patient]&clinical-status={system|}[status]

Parameters

Query parameters
Name Description
patient*
String
Who has the condition?
Required
clinical-status*
String
active | inactive | resolved
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Condition?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&clinical-status=active

search-type: Search for Condition by Patient and Category

/Condition?patient=[patient]&category={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who has the condition?
Required
category*
String
Type of plan
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Condition?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=problem-list-item

search-type: Search for Condition by Patient and Code

/Condition?patient=[patient]&code={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who has the condition?
Required
code*
String
Code for the condition
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Condition?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&code=40930008

search-type: Search for Condition by Patient and Onset Date

/Condition?patient=[patient]&onset-date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Who has the condition?
Required
onset-date*
String
Date related onsets (dateTime and Period)
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Condition?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&onset-date=ge2001-01-01

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T19:01:53.970+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T19:01:53.970+00:00",
        "versionId": "bf87540a-c6ad-488a-9007-2ebd7ac5b3a0"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Condition/8a347be9-cff4-4f10-86ea-dff590265c42",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Condition",
                "id": "8a347be9-cff4-4f10-86ea-dff590265c42",
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ],
                    "text": "Active"
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ],
                    "text": "Confirmed"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                                "code": "problem-list-item",
                                "display": "Problem List Item"
                            }
                        ],
                        "text": "Problem List Item"
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                            "code": "E03.9",
                            "display": "Hypothyroidism, unspecified"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "40930008",
                            "display": "Hypothyroidism"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "onsetString": "2006-12-31",
                "recordedDate": "2017-03-17",
                "meta": {
                    "versionId": "bf6357c1-6d9b-4945-9d0c-97f6118bb667",
                    "lastUpdated": "2022-10-26T18:47:58.115+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Condition/a6169d59-15a4-42c4-8e0b-ca33cdda9b85",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Condition",
                "id": "a6169d59-15a4-42c4-8e0b-ca33cdda9b85",
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ],
                    "text": "Active"
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ],
                    "text": "Confirmed"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                                "code": "problem-list-item",
                                "display": "Problem List Item"
                            }
                        ],
                        "text": "Problem List Item"
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                            "code": "R50.9",
                            "display": "Fever, unspecified"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "386661006",
                            "display": "Fever"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "recordedDate": "2015-06-22",
                "meta": {
                    "versionId": "95aa2fb4-f9fc-41d5-8ab3-8f45346b9778",
                    "lastUpdated": "2022-10-26T18:47:52.762+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Condition/a856bf3e-7c24-46a0-a817-03befe97181d",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Condition",
                "id": "a856bf3e-7c24-46a0-a817-03befe97181d",
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ],
                    "text": "Active"
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ],
                    "text": "Confirmed"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                                "code": "problem-list-item",
                                "display": "Problem List Item"
                            }
                        ],
                        "text": "Problem List Item"
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                            "code": "I10",
                            "display": "Essential (primary) hypertension"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "59621000",
                            "display": "Essential hypertension"
                        },
                        {
                            "system": "http://hl7.org/fhir/sid/icd-9-cm",
                            "code": "401.9",
                            "display": "Essential hypertension, unspecified"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "recordedDate": "2011-10-05",
                "meta": {
                    "versionId": "625a54a4-1b5d-435b-acb4-fee842e443af",
                    "lastUpdated": "2022-10-26T18:47:51.101+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Condition/d8dc2c05-7a11-4e6e-9f97-59b579d8a1e7",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Condition",
                "id": "d8dc2c05-7a11-4e6e-9f97-59b579d8a1e7",
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ],
                    "text": "Active"
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ],
                    "text": "Confirmed"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                                "code": "problem-list-item",
                                "display": "Problem List Item"
                            }
                        ],
                        "text": "Problem List Item"
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/icd-10-cm",
                            "code": "T86.11",
                            "display": "Kidney transplant rejection"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "236570004",
                            "display": "Renal transplant rejection"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "onsetString": "2011-12-31",
                "recordedDate": "2017-03-17",
                "meta": {
                    "versionId": "ba95dfc9-f172-4616-a5f5-ac00f6023549",
                    "lastUpdated": "2022-10-26T18:47:50.280+00:00"
                }
            }
        }
    ],
    "total": 4,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Condition?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "eb66f0c3-a5b2-439f-8032-8d2c1fb32144"
}
								  
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Capability Statement

getMetadata

Read metadata information about this server.

Read metadata.

/metadata

Parameters

N/A

Responses

Status: 200 - Success

								  
{
  "resourceType": "CapabilityStatement",
  "id": "a5e51f22-0629-4323-9910-77ad4cbf085d",
  "meta": {
    "versionId": "c684ec1c-6bab-456b-9685-c0a0be3f052d",
    "lastUpdated": "2022-12-02T06:51:57.4877106+00:00"
  },
  "language": "en-US",
  "url": "http://server.fire.ly/fhir/CapabilityStatement/FirelyServer",
  "version": "1.0",
  "name": "Firely Server 4.9.1 CapabilityStatement",
  "status": "active",
  "experimental": true,
  "date": "2022-12-02T06:51:57.4887664+00:00",
  "publisher": "Firely",
  "contact": [
    {
      "name": "Firely",
      "telecom": [
        {
          "system": "email",
          "value": "server@fire.ly",
          "use": "work"
        }
      ]
    },
    {
      "name": "Licensed to",
      "telecom": [
        {
          "system": "email",
          "value": "Randy.Norton@elekta.com",
          "use": "work"
        }
      ]
    }
  ],
  "kind": "instance",
  "software": {
    "name": "Firely Server",
    "version": "4.9.1",
    "releaseDate": "2022-08-01T07:49:36+00:00"
  },
  "implementation": {
    "description": "Firely Server",
    "url": "firely01dev.azurewebsites.net"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "AllergyIntolerance",
          "profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance",
            "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "AllergyIntolerance:asserter",
            "AllergyIntolerance:recorder",
            "AllergyIntolerance:patient"
          ],
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "ClinicalImpression:problem",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "CommunicationRequest:based-on",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:prior-request",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "MessageHeader:focus",
            "Observation:focus",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "Task:based-on",
            "Task:focus",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            },
            {
              "name": "asserter",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-asserter",
              "type": "reference",
              "documentation": "Source of the information about the allergy"
            },
            {
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category",
              "type": "token",
              "documentation": "food | medication | environment | biologic"
            },
            {
              "name": "clinical-status",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
              "type": "token",
              "documentation": "active | inactive | resolved"
            },
            {
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a  procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered"
            },
            {
              "name": "criticality",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-criticality",
              "type": "token",
              "documentation": "low | high | unable-to-assess"
            },
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination  (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier"
            },
            {
              "name": "last-date",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-last-date",
              "type": "date",
              "documentation": "Date(/time) of last known occurrence of a reaction"
            },
            {
              "name": "manifestation",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-manifestation",
              "type": "token",
              "documentation": "Clinical symptoms/signs associated with the Event"
            },
            {
              "name": "onset",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset",
              "type": "date",
              "documentation": "Date(/time) when manifestations showed"
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations  for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses  for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for"
            },
            {
              "name": "recorder",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder",
              "type": "reference",
              "documentation": "Who recorded the sensitivity"
            },
            {
              "name": "route",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-route",
              "type": "token",
              "documentation": "How the subject was exposed to the substance"
            },
            {
              "name": "severity",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-severity",
              "type": "token",
              "documentation": "mild | moderate | severe (of event as a whole)"
            },
            {
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class  - e.g. specialist referral, disease management"
            },
            {
              "name": "verification-status",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-verification-status",
              "type": "token",
              "documentation": "unconfirmed | confirmed | refuted | entered-in-error"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "Binary",
          "profile": "http://hl7.org/fhir/StructureDefinition/Binary",
          "supportedProfile": [
            "http://hl7.org/fhir/StructureDefinition/Binary"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "CommunicationRequest:based-on",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:prior-request",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "MessageHeader:focus",
            "Observation:focus",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "Task:based-on",
            "Task:focus",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "CarePlan",
          "profile": "http://hl7.org/fhir/StructureDefinition/CarePlan",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan",
            "http://hl7.org/fhir/StructureDefinition/CarePlan"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "CarePlan:activity-reference",
            "CarePlan:based-on",
            "CarePlan:care-team",
            "CarePlan:condition",
            "CarePlan:encounter",
            "CarePlan:goal",
            "CarePlan:instantiates-canonical",
            "CarePlan:part-of",
            "CarePlan:performer",
            "CarePlan:replaces",
            "CarePlan:subject",
            "CarePlan:patient"
          ],
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "CarePlan:based-on",
            "CarePlan:part-of",
            "CarePlan:replaces",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "CommunicationRequest:based-on",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:prior-request",
            "DiagnosticReport:based-on",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "ImagingStudy:basedon",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "Media:based-on",
            "MessageHeader:focus",
            "Observation:based-on",
            "Observation:focus",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Procedure:based-on",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:based-on",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "ServiceRequest:based-on",
            "Task:based-on",
            "Task:focus",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            },
            {
              "name": "activity-code",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-code",
              "type": "token",
              "documentation": "Detail type of activity"
            },
            {
              "name": "activity-date",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-date",
              "type": "date",
              "documentation": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]"
            },
            {
              "name": "activity-reference",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-reference",
              "type": "reference",
              "documentation": "Activity details defined in specific resource"
            },
            {
              "name": "based-on",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-based-on",
              "type": "reference",
              "documentation": "Fulfills CarePlan"
            },
            {
              "name": "care-team",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-care-team",
              "type": "reference",
              "documentation": "Who's involved in plan?"
            },
            {
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-category",
              "type": "token",
              "documentation": "Type of plan"
            },
            {
              "name": "condition",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-condition",
              "type": "reference",
              "documentation": "Health issues this plan addresses"
            },
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination  (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made"
            },
            {
              "name": "encounter",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-encounter",
              "type": "reference",
              "documentation": "Encounter created as part of"
            },
            {
              "name": "goal",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-goal",
              "type": "reference",
              "documentation": "Desired outcome of plan"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier"
            },
            {
              "name": "instantiates-canonical",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical",
              "type": "reference",
              "documentation": "Instantiates FHIR protocol or definition"
            },
            {
              "name": "instantiates-uri",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri",
              "type": "uri",
              "documentation": "Instantiates external protocol or definition"
            },
            {
              "name": "intent",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-intent",
              "type": "token",
              "documentation": "proposal | plan | order | option"
            },
            {
              "name": "part-of",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-part-of",
              "type": "reference",
              "documentation": "Part of referenced CarePlan"
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations  for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses  for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for"
            },
            {
              "name": "performer",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-performer",
              "type": "reference",
              "documentation": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities.  (For performers of the detailed activities, chain through the activitydetail search parameter.)"
            },
            {
              "name": "replaces",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-replaces",
              "type": "reference",
              "documentation": "CarePlan replaced by this CarePlan"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-status",
              "type": "token",
              "documentation": "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
            },
            {
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/CarePlan-subject",
              "type": "reference",
              "documentation": "Who the care plan is for"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "CareTeam",
          "profile": "http://hl7.org/fhir/StructureDefinition/CareTeam",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam",
            "http://hl7.org/fhir/StructureDefinition/CareTeam"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "CareTeam:encounter",
            "CareTeam:participant",
            "CareTeam:subject",
            "CareTeam:patient"
          ],
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "CarePlan:care-team",
            "CarePlan:performer",
            "CareTeam:participant",
            "ChargeItem:performer-actor",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "Communication:recipient",
            "CommunicationRequest:based-on",
            "CommunicationRequest:recipient",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:actor",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:performer",
            "DeviceRequest:prior-request",
            "DiagnosticReport:performer",
            "DiagnosticReport:results-interpreter",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "ImagingStudy:performer",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "Media:operator",
            "MedicationRequest:intended-performer",
            "MessageHeader:focus",
            "Observation:focus",
            "Observation:performer",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "ServiceRequest:performer",
            "Task:based-on",
            "Task:focus",
            "Task:owner",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            },
            {
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/CareTeam-category",
              "type": "token",
              "documentation": "Type of team"
            },
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination  (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made"
            },
            {
              "name": "encounter",
              "definition": "http://hl7.org/fhir/SearchParameter/CareTeam-encounter",
              "type": "reference",
              "documentation": "Encounter created as part of"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier"
            },
            {
              "name": "participant",
              "definition": "http://hl7.org/fhir/SearchParameter/CareTeam-participant",
              "type": "reference",
              "documentation": "Who is involved"
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations  for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses  for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/CareTeam-status",
              "type": "token",
              "documentation": "proposed | active | suspended | inactive | entered-in-error"
            },
            {
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/CareTeam-subject",
              "type": "reference",
              "documentation": "Who care team is for"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "Condition",
          "profile": "http://hl7.org/fhir/StructureDefinition/Condition",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition",
            "http://hl7.org/fhir/StructureDefinition/Condition"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "Condition:asserter",
            "Condition:encounter",
            "Condition:evidence-detail",
            "Condition:subject",
            "Condition:patient"
          ],
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "AdverseEvent:resultingcondition",
            "Appointment:reason-reference",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "CarePlan:condition",
            "ClinicalImpression:finding-ref",
            "ClinicalImpression:problem",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "CommunicationRequest:based-on",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:prior-request",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "Encounter:diagnosis",
            "Encounter:reason-reference",
            "EpisodeOfCare:condition",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "Immunization:reason-reference",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "MessageHeader:focus",
            "Observation:focus",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Procedure:reason-reference",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "RiskAssessment:condition",
            "Task:based-on",
            "Task:focus",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            },
            {
              "name": "abatement-age",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-age",
              "type": "quantity",
              "documentation": "Abatement as age or age range"
            },
            {
              "name": "abatement-date",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-date",
              "type": "date",
              "documentation": "Date-related abatements (dateTime and period)"
            },
            {
              "name": "abatement-string",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-string",
              "type": "string",
              "documentation": "Abatement as a string"
            },
            {
              "name": "asserter",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-asserter",
              "type": "reference",
              "documentation": "Person who asserts this condition"
            },
            {
              "name": "body-site",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-body-site",
              "type": "token",
              "documentation": "Anatomical location, if relevant"
            },
            {
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
              "type": "token",
              "documentation": "The category of the condition"
            },
            {
              "name": "clinical-status",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
              "type": "token",
              "documentation": "The clinical status of the condition"
            },
            {
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a  procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered"
            },
            {
              "name": "encounter",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-encounter",
              "type": "reference",
              "documentation": "Encounter created as part of"
            },
            {
              "name": "evidence",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence",
              "type": "token",
              "documentation": "Manifestation/symptom"
            },
            {
              "name": "evidence-detail",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence-detail",
              "type": "reference",
              "documentation": "Supporting information found elsewhere"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier"
            },
            {
              "name": "onset-age",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-age",
              "type": "quantity",
              "documentation": "Onsets as age or age range"
            },
            {
              "name": "onset-date",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
              "type": "date",
              "documentation": "Date related onsets (dateTime and Period)"
            },
            {
              "name": "onset-info",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-info",
              "type": "string",
              "documentation": "Onsets as a string"
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations  for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses  for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for"
            },
            {
              "name": "recorded-date",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-recorded-date",
              "type": "date",
              "documentation": "Date record was first recorded"
            },
            {
              "name": "severity",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-severity",
              "type": "token",
              "documentation": "The severity of the condition"
            },
            {
              "name": "stage",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-stage",
              "type": "token",
              "documentation": "Simple summary (disease specific)"
            },
            {
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-subject",
              "type": "reference",
              "documentation": "Who has the condition?"
            },
            {
              "name": "verification-status",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
              "type": "token",
              "documentation": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "Device",
          "profile": "http://hl7.org/fhir/StructureDefinition/Device",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device",
            "http://hl7.org/fhir/StructureDefinition/Device"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "Device:location",
            "Device:organization",
            "Device:patient"
          ],
          "searchRevInclude": [
            "Account:subject",
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "AdverseEvent:substance",
            "Appointment:actor",
            "Appointment:supporting-info",
            "AppointmentResponse:actor",
            "AuditEvent:agent",
            "AuditEvent:entity",
            "AuditEvent:source",
            "Basic:subject",
            "CarePlan:performer",
            "ChargeItem:enterer",
            "ChargeItem:performer-actor",
            "Claim:detail-udi",
            "Claim:item-udi",
            "Claim:procedure-udi",
            "Claim:subdetail-udi",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "Communication:recipient",
            "Communication:sender",
            "CommunicationRequest:based-on",
            "CommunicationRequest:recipient",
            "CommunicationRequest:requester",
            "CommunicationRequest:sender",
            "Composition:author",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:actor",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:author",
            "DetectedIssue:implicated",
            "DeviceMetric:parent",
            "DeviceMetric:source",
            "DeviceRequest:based-on",
            "DeviceRequest:device",
            "DeviceRequest:performer",
            "DeviceRequest:prior-request",
            "DeviceRequest:requester",
            "DeviceRequest:subject",
            "DeviceUseStatement:device",
            "DiagnosticReport:subject",
            "DocumentManifest:author",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentManifest:subject",
            "DocumentReference:author",
            "DocumentReference:related",
            "DocumentReference:subject",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "ExplanationOfBenefit:detail-udi",
            "ExplanationOfBenefit:item-udi",
            "ExplanationOfBenefit:procedure-udi",
            "ExplanationOfBenefit:subdetail-udi",
            "Flag:author",
            "Group:member",
            "ImagingStudy:performer",
            "ImagingStudy:subject",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Invoice:participant",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "List:source",
            "List:subject",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "MeasureReport:subject",
            "Media:device",
            "Media:operator",
            "Media:subject",
            "MedicationAdministration:device",
            "MedicationAdministration:performer",
            "MedicationDispense:performer",
            "MedicationRequest:intended-performer",
            "MedicationRequest:requester",
            "MessageHeader:focus",
            "MessageHeader:target",
            "Observation:device",
            "Observation:focus",
            "Observation:subject",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Procedure:performer",
            "Provenance:agent",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:author",
            "QuestionnaireResponse:subject",
            "RequestGroup:author",
            "RequestGroup:participant",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "RiskAssessment:performer",
            "Schedule:actor",
            "ServiceRequest:performer",
            "ServiceRequest:requester",
            "ServiceRequest:subject",
            "Specimen:subject",
            "SupplyRequest:requester",
            "Task:based-on",
            "Task:focus",
            "Task:owner",
            "Task:requester",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            },
            {
              "name": "device-name",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-device-name",
              "type": "string",
              "documentation": "A server defined search that may match any of the string fields in Device.deviceName or Device.type."
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-identifier",
              "type": "token",
              "documentation": "Instance id from manufacturer, owner, and others"
            },
            {
              "name": "location",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-location",
              "type": "reference",
              "documentation": "A location, where the resource is found"
            },
            {
              "name": "manufacturer",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-manufacturer",
              "type": "string",
              "documentation": "The manufacturer of the device"
            },
            {
              "name": "model",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-model",
              "type": "string",
              "documentation": "The model of the device"
            },
            {
              "name": "organization",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-organization",
              "type": "reference",
              "documentation": "The organization responsible for the device"
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-patient",
              "type": "reference",
              "documentation": "Patient information, if the resource is affixed to a person"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-status",
              "type": "token",
              "documentation": "active | inactive | entered-in-error | unknown"
            },
            {
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-type",
              "type": "token",
              "documentation": "The type of the device"
            },
            {
              "name": "udi-carrier",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-udi-carrier",
              "type": "string",
              "documentation": "UDI Barcode (RFID or other technology) string in *HRF* format."
            },
            {
              "name": "udi-di",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-udi-di",
              "type": "string",
              "documentation": "The udi Device Identifier (DI)"
            },
            {
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/Device-url",
              "type": "uri",
              "documentation": "Network address to contact device"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "DiagnosticReport",
          "profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note",
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab",
            "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
            "http://hl7.org/fhir/StructureDefinition/hlaresult",
            "http://hl7.org/fhir/StructureDefinition/diagnosticreport-genetics",
            "http://hl7.org/fhir/StructureDefinition/lipidprofile"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "DiagnosticReport:encounter",
            "DiagnosticReport:based-on",
            "DiagnosticReport:media",
            "DiagnosticReport:performer",
            "DiagnosticReport:result",
            "DiagnosticReport:results-interpreter",
            "DiagnosticReport:specimen",
            "DiagnosticReport:subject",
            "DiagnosticReport:patient"
          ],
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "ChargeItem:service",
            "ClinicalImpression:investigation",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "CommunicationRequest:based-on",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:data",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:prior-request",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "Immunization:reason-reference",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "MessageHeader:focus",
            "Observation:focus",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Procedure:reason-reference",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "Task:based-on",
            "Task:focus",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_security",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type": "token",
              "documentation": "Security Labels applied to this resource"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_tag",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
              "type": "token",
              "documentation": "Tags applied to this resource"
            },
            {
              "name": "based-on",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-based-on",
              "type": "reference",
              "documentation": "Reference to the service request."
            },
            {
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
              "type": "token",
              "documentation": "Which diagnostic discipline/department created the report"
            },
            {
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a  procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered"
            },
            {
              "name": "conclusion",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-conclusion",
              "type": "token",
              "documentation": "A coded conclusion (interpretation/impression) on the report"
            },
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination  (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made"
            },
            {
              "name": "encounter",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
              "type": "reference",
              "documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document  content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier"
            },
            {
              "name": "issued",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-issued",
              "type": "date",
              "documentation": "When the report was issued"
            },
            {
              "name": "media",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-media",
              "type": "reference",
              "documentation": "A reference to the image source."
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations  for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses  for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for"
            },
            {
              "name": "performer",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-performer",
              "type": "reference",
              "documentation": "Who is responsible for the report"
            },
            {
              "name": "result",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-result",
              "type": "reference",
              "documentation": "Link to an atomic result (observation resource)"
            },
            {
              "name": "results-interpreter",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-results-interpreter",
              "type": "reference",
              "documentation": "Who was the source of the report"
            },
            {
              "name": "specimen",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-specimen",
              "type": "reference",
              "documentation": "The specimen details"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
              "type": "token",
              "documentation": "The status of the report"
            },
            {
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-subject",
              "type": "reference",
              "documentation": "The subject of the report"
            }
          ],
          "operation": [
            {
              "name": "meta-add",
              "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add"
            }
          ]
        },
        {
          "type": "DocumentReference",
          "profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference",
            "http://hl7.org/fhir/StructureDefinition/DocumentReference"
          ],
          "interaction": [
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "patch"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "vread"
            }
          ],
          "versioning": "versioned",
          "readHistory": true,
          "conditionalCreate": false,
          "conditionalRead": "full-support",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchInclude": [
            "DocumentReference:encounter",
            "DocumentReference:authenticator",
            "DocumentReference:author",
            "DocumentReference:custodian",
            "DocumentReference:related",
            "DocumentReference:relatesto",
            "DocumentReference:subject",
            "DocumentReference:patient"
          ],
          "searchRevInclude": [
            "ActivityDefinition:composed-of",
            "ActivityDefinition:depends-on",
            "ActivityDefinition:derived-from",
            "ActivityDefinition:predecessor",
            "ActivityDefinition:successor",
            "Appointment:supporting-info",
            "AuditEvent:entity",
            "Basic:subject",
            "ClinicalImpression:supporting-info",
            "Communication:based-on",
            "Communication:part-of",
            "CommunicationRequest:based-on",
            "Composition:entry",
            "Composition:subject",
            "Condition:evidence-detail",
            "Consent:data",
            "Consent:source-reference",
            "Contract:subject",
            "DetectedIssue:implicated",
            "DeviceRequest:based-on",
            "DeviceRequest:prior-request",
            "DocumentManifest:item",
            "DocumentManifest:related-ref",
            "DocumentReference:related",
            "DocumentReference:relatesto",
            "EventDefinition:composed-of",
            "EventDefinition:depends-on",
            "EventDefinition:derived-from",
            "EventDefinition:predecessor",
            "EventDefinition:successor",
            "Evidence:composed-of",
            "Evidence:depends-on",
            "Evidence:derived-from",
            "Evidence:predecessor",
            "Evidence:successor",
            "EvidenceVariable:composed-of",
            "EvidenceVariable:depends-on",
            "EvidenceVariable:derived-from",
            "EvidenceVariable:predecessor",
            "EvidenceVariable:successor",
            "ImmunizationRecommendation:information",
            "ImplementationGuide:resource",
            "Library:composed-of",
            "Library:depends-on",
            "Library:derived-from",
            "Library:predecessor",
            "Library:successor",
            "Linkage:item",
            "Linkage:source",
            "List:item",
            "Measure:composed-of",
            "Measure:depends-on",
            "Measure:derived-from",
            "Measure:predecessor",
            "Measure:successor",
            "MeasureReport:evaluated-resource",
            "MedicationKnowledge:monograph",
            "MessageHeader:focus",
            "Observation:derived-from",
            "Observation:focus",
            "PaymentNotice:request",
            "PaymentNotice:response",
            "PlanDefinition:composed-of",
            "PlanDefinition:depends-on",
            "PlanDefinition:derived-from",
            "PlanDefinition:predecessor",
            "PlanDefinition:successor",
            "Procedure:reason-reference",
            "Provenance:entity",
            "Provenance:target",
            "QuestionnaireResponse:subject",
            "ResearchDefinition:composed-of",
            "ResearchDefinition:depends-on",
            "ResearchDefinition:derived-from",
            "ResearchDefinition:predecessor",
            "ResearchDefinition:successor",
            "ResearchElementDefinition:composed-of",
            "ResearchElementDefinition:depends-on",
            "ResearchElementDefinition:derived-from",
            "ResearchElementDefinition:predecessor",
            "ResearchElementDefinition:successor",
            "Task:based-on",
            "Task:focus",
            "Task:subject",
            "VerificationResult:target"
          ],
          "searchParam": [
            {
              "name": "_count",
              "type": "number",
              "documentation": "The number of resources returned per page"
            },
            {
              "name": "_format",
              "type": "string",
              "documentation": "Specify the returned format of the payload response"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Enables querying a reverse chain"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id",
              "type": "token",
              "documentation": "Logical id of this artifact
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer conformance expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - comparator
\n - modifier
\n - chain
" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "authenticator", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator", "type": "reference", "documentation": "Who/what authenticated the document" }, { "name": "author", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author", "type": "reference", "documentation": "Who and/or what authored the document" }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category", "type": "token", "documentation": "Categorization of document" }, { "name": "contenttype", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype", "type": "token", "documentation": "Mime type of the content, with charset etc." }, { "name": "custodian", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian", "type": "reference", "documentation": "Organization which maintains the document" }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-date", "type": "date", "documentation": "When this document reference was created" }, { "name": "description", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-description", "type": "string", "documentation": "Human-readable description" }, { "name": "encounter", "definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "event", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event", "type": "token", "documentation": "Main clinical acts documented" }, { "name": "facility", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility", "type": "token", "documentation": "Kind of facility where patient was seen" }, { "name": "format", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format", "type": "token", "documentation": "Format/content rules for the document" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "language", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-language", "type": "token", "documentation": "Human language of the content (BCP-47)" }, { "name": "location", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-location", "type": "uri", "documentation": "Uri where the data can be found" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "period", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period", "type": "date", "documentation": "Time of service that is being documented" }, { "name": "related", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related", "type": "reference", "documentation": "Related identifiers or resources" }, { "name": "relatesto", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto", "type": "reference", "documentation": "Target of the relationship" }, { "name": "relation", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relation", "type": "token", "documentation": "replaces | transforms | signs | appends" }, { "name": "relationship", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relationship", "type": "composite", "documentation": "Combination of relation and relatesTo" }, { "name": "security-label", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label", "type": "token", "documentation": "Document security-tags" }, { "name": "setting", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting", "type": "token", "documentation": "Additional details about where the content was created (e.g. clinical specialty)" }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status", "type": "token", "documentation": "current | superseded | entered-in-error" }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject", "type": "reference", "documentation": "Who/what is the subject of the document" }, { "name": "type", "definition": "http://hl7.org/fhir/SearchParameter/clinical-type", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Encounter", "profile": "http://hl7.org/fhir/StructureDefinition/Encounter", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter", "http://hl7.org/fhir/StructureDefinition/Encounter" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Encounter:account", "Encounter:appointment", "Encounter:based-on", "Encounter:diagnosis", "Encounter:episode-of-care", "Encounter:location", "Encounter:part-of", "Encounter:participant", "Encounter:practitioner", "Encounter:reason-reference", "Encounter:service-provider", "Encounter:subject", "Encounter:patient" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:encounter", "CareTeam:encounter", "ChargeItem:context", "Claim:encounter", "ClinicalImpression:encounter", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:encounter", "Communication:part-of", "CommunicationRequest:based-on", "CommunicationRequest:encounter", "Composition:encounter", "DeviceRequest:encounter", "DiagnosticReport:encounter", "DocumentReference:encounter", "Flag:encounter", "List:encounter", "NutritionOrder:encounter", "Observation:encounter", "Procedure:encounter", "RiskAssessment:encounter", "ServiceRequest:encounter", "VisionPrescription:encounter", "Composition:entry", "Composition:subject", "Condition:encounter", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:part-of", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:encounter", "ImagingStudy:encounter", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "Media:encounter", "MedicationAdministration:context", "MedicationDispense:context", "MedicationRequest:encounter", "MedicationStatement:context", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:encounter", "QuestionnaireResponse:subject", "RequestGroup:encounter", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:encounter", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id", "type": "token", "documentation": "Logical id of this artifact
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer conformance expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - comparator
\n - modifier
\n - chain
" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "account", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-account", "type": "reference", "documentation": "The set of accounts that may be used for billing for this Encounter" }, { "name": "appointment", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-appointment", "type": "reference", "documentation": "The appointment that scheduled this encounter" }, { "name": "based-on", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-based-on", "type": "reference", "documentation": "The ServiceRequest that initiated this encounter" }, { "name": "class", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-class", "type": "token", "documentation": "Classification of patient encounter" }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made" }, { "name": "diagnosis", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-diagnosis", "type": "reference", "documentation": "The diagnosis or procedure relevant to the encounter" }, { "name": "episode-of-care", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care", "type": "reference", "documentation": "Episode(s) of care that this encounter should be recorded against" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "length", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-length", "type": "quantity", "documentation": "Length of encounter in days" }, { "name": "location", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-location", "type": "reference", "documentation": "Location the encounter takes place" }, { "name": "location-period", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-location-period", "type": "date", "documentation": "Time period during which the patient was present at the location" }, { "name": "participant", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant", "type": "reference", "documentation": "Persons involved in the encounter other than the patient" }, { "name": "participant-type", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant-type", "type": "token", "documentation": "Role of participant in encounter" }, { "name": "part-of", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-part-of", "type": "reference", "documentation": "Another Encounter this encounter is part of" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "practitioner", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-practitioner", "type": "reference", "documentation": "Persons involved in the encounter other than the patient" }, { "name": "reason-code", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-reason-code", "type": "token", "documentation": "Coded reason the encounter takes place" }, { "name": "reason-reference", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-reason-reference", "type": "reference", "documentation": "Reason the encounter takes place (reference)" }, { "name": "service-provider", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-service-provider", "type": "reference", "documentation": "The organization (facility) responsible for this encounter" }, { "name": "special-arrangement", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement", "type": "token", "documentation": "Wheelchair, translator, stretcher, etc." }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-status", "type": "token", "documentation": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +" }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/Encounter-subject", "type": "reference", "documentation": "The patient or group present at the encounter" }, { "name": "type", "definition": "http://hl7.org/fhir/SearchParameter/clinical-type", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Goal", "profile": "http://hl7.org/fhir/StructureDefinition/Goal", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal", "http://hl7.org/fhir/StructureDefinition/Goal" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Goal:subject", "Goal:patient" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:goal", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "achievement-status", "definition": "http://hl7.org/fhir/SearchParameter/Goal-achievement-status", "type": "token", "documentation": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable" }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/Goal-category", "type": "token", "documentation": "E.g. Treatment, dietary, behavioral, etc." }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "lifecycle-status", "definition": "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status", "type": "token", "documentation": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "start-date", "definition": "http://hl7.org/fhir/SearchParameter/Goal-start-date", "type": "date", "documentation": "When goal pursuit begins" }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/Goal-subject", "type": "reference", "documentation": "Who this goal is intended for" }, { "name": "target-date", "definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date", "type": "date", "documentation": "Reach goal on or before" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Immunization", "profile": "http://hl7.org/fhir/StructureDefinition/Immunization", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization", "http://hl7.org/fhir/StructureDefinition/Immunization" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Immunization:location", "Immunization:manufacturer", "Immunization:performer", "Immunization:reaction", "Immunization:reason-reference", "Immunization:patient" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:substance", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:service", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationEvaluation:immunization-event", "ImmunizationRecommendation:information", "ImmunizationRecommendation:support", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "Observation:part-of", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "location", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-location", "type": "reference", "documentation": "The service delivery location or facility in which the vaccine was / was to be administered" }, { "name": "lot-number", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-lot-number", "type": "string", "documentation": "Vaccine Lot Number" }, { "name": "manufacturer", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-manufacturer", "type": "reference", "documentation": "Vaccine Manufacturer" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-performer", "type": "reference", "documentation": "The practitioner or organization who played a role in the vaccination" }, { "name": "reaction", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction", "type": "reference", "documentation": "Additional information on reaction" }, { "name": "reaction-date", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction-date", "type": "date", "documentation": "When reaction started" }, { "name": "reason-code", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-code", "type": "token", "documentation": "Reason why the vaccine was administered" }, { "name": "reason-reference", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-reference", "type": "reference", "documentation": "Why immunization occurred" }, { "name": "series", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-series", "type": "string", "documentation": "The series being followed by the provider" }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-status", "type": "token", "documentation": "Immunization event status" }, { "name": "status-reason", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-status-reason", "type": "token", "documentation": "Reason why the vaccine was not administered" }, { "name": "target-disease", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-target-disease", "type": "token", "documentation": "The target disease the dose is being administered against" }, { "name": "vaccine-code", "definition": "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code", "type": "token", "documentation": "Vaccine Product Administered" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Location", "profile": "http://hl7.org/fhir/StructureDefinition/Location", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location", "http://hl7.org/fhir/StructureDefinition/Location" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Location:endpoint", "Location:organization", "Location:partof" ], "searchRevInclude": [ "Account:subject", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:location", "Appointment:actor", "Appointment:location", "Appointment:supporting-info", "AppointmentResponse:actor", "AppointmentResponse:location", "AuditEvent:entity", "Basic:subject", "Claim:facility", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:domain", "Contract:subject", "CoverageEligibilityRequest:facility", "DetectedIssue:implicated", "Device:location", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DeviceRequest:subject", "DiagnosticReport:subject", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:location", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:facility", "Flag:subject", "HealthcareService:coverage-area", "HealthcareService:location", "Immunization:location", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "List:subject", "Location:partof", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MeasureReport:reporter", "MeasureReport:subject", "Media:subject", "MedicationDispense:destination", "MessageHeader:focus", "Observation:focus", "Observation:subject", "OrganizationAffiliation:location", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "PractitionerRole:location", "Procedure:location", "Provenance:entity", "Provenance:location", "Provenance:target", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ResearchStudy:site", "Schedule:actor", "ServiceRequest:subject", "Specimen:subject", "SupplyRequest:subject", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "address", "definition": "http://hl7.org/fhir/SearchParameter/Location-address", "type": "string", "documentation": "A (part of the) address of the location" }, { "name": "address-city", "definition": "http://hl7.org/fhir/SearchParameter/Location-address-city", "type": "string", "documentation": "A city specified in an address" }, { "name": "address-country", "definition": "http://hl7.org/fhir/SearchParameter/Location-address-country", "type": "string", "documentation": "A country specified in an address" }, { "name": "address-postalcode", "definition": "http://hl7.org/fhir/SearchParameter/Location-address-postalcode", "type": "string", "documentation": "A postal code specified in an address" }, { "name": "address-state", "definition": "http://hl7.org/fhir/SearchParameter/Location-address-state", "type": "string", "documentation": "A state specified in an address" }, { "name": "address-use", "definition": "http://hl7.org/fhir/SearchParameter/Location-address-use", "type": "token", "documentation": "A use code specified in an address" }, { "name": "endpoint", "definition": "http://hl7.org/fhir/SearchParameter/Location-endpoint", "type": "reference", "documentation": "Technical endpoints providing access to services operated for the location" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/Location-identifier", "type": "token", "documentation": "An identifier for the location" }, { "name": "name", "definition": "http://hl7.org/fhir/SearchParameter/Location-name", "type": "string", "documentation": "A portion of the location's name or alias" }, { "name": "near", "definition": "http://hl7.org/fhir/SearchParameter/Location-near", "type": "special", "documentation": "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also" }, { "name": "operational-status", "definition": "http://hl7.org/fhir/SearchParameter/Location-operational-status", "type": "token", "documentation": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)" }, { "name": "organization", "definition": "http://hl7.org/fhir/SearchParameter/Location-organization", "type": "reference", "documentation": "Searches for locations that are managed by the provided organization" }, { "name": "partof", "definition": "http://hl7.org/fhir/SearchParameter/Location-partof", "type": "reference", "documentation": "A location of which this location is a part" }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/Location-status", "type": "token", "documentation": "Searches for locations with a specific kind of status" }, { "name": "type", "definition": "http://hl7.org/fhir/SearchParameter/Location-type", "type": "token", "documentation": "A code for the type of location" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "MedicationRequest", "profile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest", "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "MedicationRequest:medication", "MedicationRequest:encounter", "MedicationRequest:intended-dispenser", "MedicationRequest:intended-performer", "MedicationRequest:requester", "MedicationRequest:subject", "MedicationRequest:patient" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:activity-reference", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DiagnosticReport:based-on", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MedicationAdministration:request", "MedicationDispense:prescription", "MessageHeader:focus", "Observation:based-on", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ServiceRequest:based-on", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "authoredon", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon", "type": "date", "documentation": "Return prescriptions written on this date" }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-category", "type": "token", "documentation": "Returns prescriptions with different categories" }, { "name": "code", "definition": "http://hl7.org/fhir/SearchParameter/clinical-code", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/medications-date", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date" }, { "name": "encounter", "definition": "http://hl7.org/fhir/SearchParameter/medications-encounter", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "intended-dispenser", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-dispenser", "type": "reference", "documentation": "Returns prescriptions intended to be dispensed by this Organization" }, { "name": "intended-performer", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-performer", "type": "reference", "documentation": "Returns the intended performer of the administration of the medication request" }, { "name": "intended-performertype", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-performertype", "type": "token", "documentation": "Returns requests for a specific type of performer" }, { "name": "intent", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent", "type": "token", "documentation": "Returns prescriptions with different intents" }, { "name": "medication", "definition": "http://hl7.org/fhir/SearchParameter/medications-medication", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "priority", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-priority", "type": "token", "documentation": "Returns prescriptions with different priorities" }, { "name": "requester", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-requester", "type": "reference", "documentation": "Returns prescriptions prescribed by this prescriber" }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/medications-status", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status" }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-subject", "type": "reference", "documentation": "The identity of a patient to list orders for" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Observation", "profile": "http://hl7.org/fhir/StructureDefinition/Observation", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age", "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/ldlcholesterol", "http://hl7.org/fhir/StructureDefinition/hdlcholesterol", "http://hl7.org/fhir/StructureDefinition/triglyceride", "http://hl7.org/fhir/StructureDefinition/cholesterol", "http://hl7.org/fhir/StructureDefinition/bp", "http://hl7.org/fhir/StructureDefinition/bmi", "http://hl7.org/fhir/StructureDefinition/oxygensat", "http://hl7.org/fhir/StructureDefinition/headcircum", "http://hl7.org/fhir/StructureDefinition/bodytemp", "http://hl7.org/fhir/StructureDefinition/heartrate", "http://hl7.org/fhir/StructureDefinition/resprate", "http://hl7.org/fhir/StructureDefinition/bodyheight", "http://hl7.org/fhir/StructureDefinition/vitalspanel", "http://hl7.org/fhir/StructureDefinition/bodyweight", "http://hl7.org/fhir/StructureDefinition/vitalsigns", "http://hl7.org/fhir/StructureDefinition/observation-genetics", "http://hl7.org/fhir/StructureDefinition/devicemetricobservation" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Observation:encounter", "Observation:based-on", "Observation:derived-from", "Observation:device", "Observation:focus", "Observation:has-member", "Observation:part-of", "Observation:performer", "Observation:specimen", "Observation:subject", "Observation:patient" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:reason-reference", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:service", "ClinicalImpression:finding-ref", "ClinicalImpression:investigation", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DiagnosticReport:result", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:reason-reference", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "Immunization:reaction", "Immunization:reason-reference", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MedicationStatement:part-of", "MessageHeader:focus", "Observation:derived-from", "Observation:focus", "Observation:has-member", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:part-of", "Procedure:reason-reference", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:part-of", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "based-on", "definition": "http://hl7.org/fhir/SearchParameter/Observation-based-on", "type": "reference", "documentation": "Reference to the service request." }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/Observation-category", "type": "token", "documentation": "The classification of the type of observation" }, { "name": "code", "definition": "http://hl7.org/fhir/SearchParameter/clinical-code", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "code-value-concept", "definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-concept", "type": "composite", "documentation": "Code and coded value parameter pair" }, { "name": "code-value-date", "definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-date", "type": "composite", "documentation": "Code and date/time value parameter pair" }, { "name": "code-value-quantity", "definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity", "type": "composite", "documentation": "Code and quantity value parameter pair" }, { "name": "code-value-string", "definition": "http://hl7.org/fhir/SearchParameter/Observation-code-value-string", "type": "composite", "documentation": "Code and string value parameter pair" }, { "name": "combo-code", "definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-code", "type": "token", "documentation": "The code of the observation type or component type" }, { "name": "combo-code-value-concept", "definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept", "type": "composite", "documentation": "Code and coded value parameter pair, including in components" }, { "name": "combo-code-value-quantity", "definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity", "type": "composite", "documentation": "Code and quantity value parameter pair, including in components" }, { "name": "combo-data-absent-reason", "definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-data-absent-reason", "type": "token", "documentation": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing." }, { "name": "combo-value-concept", "definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept", "type": "token", "documentation": "The value or component value of the observation, if the value is a CodeableConcept" }, { "name": "combo-value-quantity", "definition": "http://hl7.org/fhir/SearchParameter/Observation-combo-value-quantity", "type": "quantity", "documentation": "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)" }, { "name": "component-code", "definition": "http://hl7.org/fhir/SearchParameter/Observation-component-code", "type": "token", "documentation": "The component code of the observation type" }, { "name": "component-code-value-concept", "definition": "http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept", "type": "composite", "documentation": "Component code and component coded value parameter pair" }, { "name": "component-code-value-quantity", "definition": "http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity", "type": "composite", "documentation": "Component code and component quantity value parameter pair" }, { "name": "component-data-absent-reason", "definition": "http://hl7.org/fhir/SearchParameter/Observation-component-data-absent-reason", "type": "token", "documentation": "The reason why the expected value in the element Observation.component.value[x] is missing." }, { "name": "component-value-concept", "definition": "http://hl7.org/fhir/SearchParameter/Observation-component-value-concept", "type": "token", "documentation": "The value of the component observation, if the value is a CodeableConcept" }, { "name": "component-value-quantity", "definition": "http://hl7.org/fhir/SearchParameter/Observation-component-value-quantity", "type": "quantity", "documentation": "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)" }, { "name": "data-absent-reason", "definition": "http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason", "type": "token", "documentation": "The reason why the expected value in the element Observation.value[x] is missing." }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made" }, { "name": "derived-from", "definition": "http://hl7.org/fhir/SearchParameter/Observation-derived-from", "type": "reference", "documentation": "Related measurements the observation is made from" }, { "name": "device", "definition": "http://hl7.org/fhir/SearchParameter/Observation-device", "type": "reference", "documentation": "The Device that generated the observation data." }, { "name": "encounter", "definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "focus", "definition": "http://hl7.org/fhir/SearchParameter/Observation-focus", "type": "reference", "documentation": "The focus of an observation when the focus is not the patient of record." }, { "name": "has-member", "definition": "http://hl7.org/fhir/SearchParameter/Observation-has-member", "type": "reference", "documentation": "Related resource that belongs to the Observation group" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "method", "definition": "http://hl7.org/fhir/SearchParameter/Observation-method", "type": "token", "documentation": "The method used for the observation" }, { "name": "part-of", "definition": "http://hl7.org/fhir/SearchParameter/Observation-part-of", "type": "reference", "documentation": "Part of referenced event" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "definition": "http://hl7.org/fhir/SearchParameter/Observation-performer", "type": "reference", "documentation": "Who performed the observation" }, { "name": "specimen", "definition": "http://hl7.org/fhir/SearchParameter/Observation-specimen", "type": "reference", "documentation": "Specimen used for this observation" }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/Observation-status", "type": "token", "documentation": "The status of the observation" }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/Observation-subject", "type": "reference", "documentation": "The subject that the observation is about" }, { "name": "value-concept", "definition": "http://hl7.org/fhir/SearchParameter/Observation-value-concept", "type": "token", "documentation": "The value of the observation, if the value is a CodeableConcept" }, { "name": "value-date", "definition": "http://hl7.org/fhir/SearchParameter/Observation-value-date", "type": "date", "documentation": "The value of the observation, if the value is a date or period of time" }, { "name": "value-quantity", "definition": "http://hl7.org/fhir/SearchParameter/Observation-value-quantity", "type": "quantity", "documentation": "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)" }, { "name": "value-string", "definition": "http://hl7.org/fhir/SearchParameter/Observation-value-string", "type": "string", "documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Organization", "profile": "http://hl7.org/fhir/StructureDefinition/Organization", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization", "http://hl7.org/fhir/StructureDefinition/Organization" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Organization:endpoint", "Organization:partof" ], "searchRevInclude": [ "Account:owner", "Account:subject", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:agent", "AuditEvent:entity", "AuditEvent:source", "Basic:author", "Basic:subject", "CarePlan:performer", "CareTeam:participant", "ChargeItem:enterer", "ChargeItem:performer-actor", "ChargeItem:performing-organization", "ChargeItem:requesting-organization", "Claim:care-team", "Claim:insurer", "Claim:payee", "Claim:provider", "ClaimResponse:insurer", "ClaimResponse:requestor", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:recipient", "Communication:sender", "CommunicationRequest:based-on", "CommunicationRequest:recipient", "CommunicationRequest:requester", "CommunicationRequest:sender", "Composition:attester", "Composition:author", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:actor", "Consent:consentor", "Consent:data", "Consent:organization", "Contract:authority", "Contract:signer", "Contract:subject", "Coverage:payor", "Coverage:policy-holder", "CoverageEligibilityRequest:provider", "CoverageEligibilityResponse:insurer", "CoverageEligibilityResponse:requestor", "DetectedIssue:implicated", "Device:organization", "DeviceRequest:based-on", "DeviceRequest:performer", "DeviceRequest:prior-request", "DeviceRequest:requester", "DiagnosticReport:performer", "DiagnosticReport:results-interpreter", "DocumentManifest:author", "DocumentManifest:item", "DocumentManifest:recipient", "DocumentManifest:related-ref", "DocumentReference:authenticator", "DocumentReference:author", "DocumentReference:custodian", "DocumentReference:related", "Encounter:service-provider", "Endpoint:organization", "EpisodeOfCare:organization", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:care-team", "ExplanationOfBenefit:payee", "ExplanationOfBenefit:provider", "Flag:author", "Flag:subject", "Goal:subject", "Group:managing-entity", "HealthcareService:organization", "ImagingStudy:performer", "Immunization:manufacturer", "Immunization:performer", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "InsurancePlan:administered-by", "InsurancePlan:owned-by", "Invoice:issuer", "Invoice:participant", "Invoice:recipient", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:author", "Linkage:item", "Linkage:source", "List:item", "Location:organization", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MeasureReport:reporter", "Media:operator", "Medication:manufacturer", "MedicationDispense:performer", "MedicationKnowledge:manufacturer", "MedicationRequest:intended-dispenser", "MedicationRequest:intended-performer", "MedicationRequest:requester", "MedicationStatement:source", "MedicinalProductAuthorization:holder", "MessageHeader:focus", "MessageHeader:receiver", "MessageHeader:responsible", "MessageHeader:sender", "Observation:focus", "Observation:performer", "Organization:partof", "OrganizationAffiliation:network", "OrganizationAffiliation:participating-organization", "OrganizationAffiliation:primary-organization", "Patient:general-practitioner", "Patient:organization", "PaymentNotice:provider", "PaymentNotice:request", "PaymentNotice:response", "PaymentReconciliation:payment-issuer", "PaymentReconciliation:requestor", "Person:organization", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "PractitionerRole:organization", "Procedure:performer", "Provenance:agent", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:author", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ResearchStudy:sponsor", "ServiceRequest:performer", "ServiceRequest:requester", "SupplyDelivery:supplier", "SupplyRequest:requester", "SupplyRequest:subject", "SupplyRequest:supplier", "Task:based-on", "Task:focus", "Task:owner", "Task:requester", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "active", "definition": "http://hl7.org/fhir/SearchParameter/Organization-active", "type": "token", "documentation": "Is the Organization record active" }, { "name": "address", "definition": "http://hl7.org/fhir/SearchParameter/Organization-address", "type": "string", "documentation": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "address-city", "definition": "http://hl7.org/fhir/SearchParameter/Organization-address-city", "type": "string", "documentation": "A city specified in an address" }, { "name": "address-country", "definition": "http://hl7.org/fhir/SearchParameter/Organization-address-country", "type": "string", "documentation": "A country specified in an address" }, { "name": "address-postalcode", "definition": "http://hl7.org/fhir/SearchParameter/Organization-address-postalcode", "type": "string", "documentation": "A postal code specified in an address" }, { "name": "address-state", "definition": "http://hl7.org/fhir/SearchParameter/Organization-address-state", "type": "string", "documentation": "A state specified in an address" }, { "name": "address-use", "definition": "http://hl7.org/fhir/SearchParameter/Organization-address-use", "type": "token", "documentation": "A use code specified in an address" }, { "name": "endpoint", "definition": "http://hl7.org/fhir/SearchParameter/Organization-endpoint", "type": "reference", "documentation": "Technical endpoints providing access to services operated for the organization" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier", "type": "token", "documentation": "Any identifier for the organization (not the accreditation issuer's identifier)" }, { "name": "name", "definition": "http://hl7.org/fhir/SearchParameter/Organization-name", "type": "string", "documentation": "A portion of the organization's name or alias" }, { "name": "partof", "definition": "http://hl7.org/fhir/SearchParameter/Organization-partof", "type": "reference", "documentation": "An organization of which this organization forms a part" }, { "name": "phonetic", "definition": "http://hl7.org/fhir/SearchParameter/Organization-phonetic", "type": "string", "documentation": "A portion of the organization's name using some kind of phonetic matching algorithm" }, { "name": "type", "definition": "http://hl7.org/fhir/SearchParameter/Organization-type", "type": "token", "documentation": "A code for the type of organization" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Patient", "profile": "http://hl7.org/fhir/StructureDefinition/Patient", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient", "http://hl7.org/fhir/StructureDefinition/Patient" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Patient:general-practitioner", "Patient:link", "Patient:organization" ], "searchRevInclude": [ "Account:patient", "Account:subject", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:recorder", "AdverseEvent:subject", "AllergyIntolerance:asserter", "AllergyIntolerance:recorder", "Appointment:actor", "Appointment:patient", "Appointment:supporting-info", "AppointmentResponse:actor", "AppointmentResponse:patient", "AuditEvent:agent", "AuditEvent:entity", "AuditEvent:patient", "AuditEvent:source", "Basic:author", "Basic:patient", "Basic:subject", "BodyStructure:patient", "CarePlan:performer", "CarePlan:subject", "CareTeam:participant", "CareTeam:subject", "ChargeItem:enterer", "ChargeItem:patient", "ChargeItem:performer-actor", "ChargeItem:subject", "Claim:patient", "Claim:payee", "ClaimResponse:patient", "ClinicalImpression:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:patient", "Communication:recipient", "Communication:sender", "Communication:subject", "CommunicationRequest:based-on", "CommunicationRequest:patient", "CommunicationRequest:recipient", "CommunicationRequest:requester", "CommunicationRequest:sender", "CommunicationRequest:subject", "Composition:attester", "Composition:author", "Composition:entry", "Composition:subject", "Condition:asserter", "Condition:evidence-detail", "Condition:subject", "Consent:actor", "Consent:consentor", "Consent:data", "Contract:patient", "Contract:signer", "Contract:subject", "Coverage:beneficiary", "Coverage:patient", "Coverage:payor", "Coverage:policy-holder", "Coverage:subscriber", "CoverageEligibilityRequest:patient", "CoverageEligibilityResponse:patient", "DetectedIssue:implicated", "Device:patient", "DeviceRequest:based-on", "DeviceRequest:performer", "DeviceRequest:prior-request", "DeviceRequest:subject", "DeviceUseStatement:subject", "DiagnosticReport:subject", "DocumentManifest:author", "DocumentManifest:item", "DocumentManifest:recipient", "DocumentManifest:related-ref", "DocumentManifest:subject", "DocumentReference:author", "DocumentReference:related", "DocumentReference:subject", "Encounter:subject", "EnrollmentRequest:patient", "EnrollmentRequest:subject", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:patient", "ExplanationOfBenefit:payee", "Flag:author", "Flag:subject", "Goal:subject", "Group:member", "GuidanceResponse:patient", "GuidanceResponse:subject", "ImagingStudy:performer", "ImagingStudy:subject", "ImmunizationEvaluation:patient", "ImmunizationRecommendation:information", "ImmunizationRecommendation:patient", "ImplementationGuide:resource", "Invoice:participant", "Invoice:patient", "Invoice:recipient", "Invoice:subject", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "List:source", "List:subject", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MeasureReport:patient", "MeasureReport:subject", "Media:operator", "Media:patient", "Media:subject", "MedicationAdministration:performer", "MedicationAdministration:subject", "MedicationDispense:performer", "MedicationDispense:receiver", "MedicationDispense:subject", "MedicationRequest:intended-performer", "MedicationRequest:requester", "MedicationRequest:subject", "MedicationStatement:source", "MedicationStatement:subject", "MessageHeader:focus", "MolecularSequence:patient", "Observation:focus", "Observation:performer", "Observation:subject", "Patient:link", "PaymentNotice:request", "PaymentNotice:response", "Person:link", "Person:patient", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:performer", "Procedure:subject", "Provenance:agent", "Provenance:entity", "Provenance:patient", "Provenance:target", "QuestionnaireResponse:author", "QuestionnaireResponse:patient", "QuestionnaireResponse:source", "QuestionnaireResponse:subject", "RelatedPerson:patient", "RequestGroup:participant", "RequestGroup:patient", "RequestGroup:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ResearchSubject:individual", "ResearchSubject:patient", "RiskAssessment:subject", "Schedule:actor", "ServiceRequest:performer", "ServiceRequest:requester", "ServiceRequest:subject", "Specimen:patient", "Specimen:subject", "SupplyRequest:requester", "SupplyRequest:subject", "Task:based-on", "Task:focus", "Task:owner", "Task:patient", "Task:requester", "Task:subject", "VerificationResult:target", "AllergyIntolerance:patient", "CarePlan:patient", "CareTeam:patient", "ClinicalImpression:patient", "Composition:patient", "Condition:patient", "Consent:patient", "DetectedIssue:patient", "DeviceRequest:patient", "DeviceUseStatement:patient", "DiagnosticReport:patient", "DocumentManifest:patient", "DocumentReference:patient", "Encounter:patient", "EpisodeOfCare:patient", "FamilyMemberHistory:patient", "Flag:patient", "Goal:patient", "ImagingStudy:patient", "Immunization:patient", "List:patient", "MedicationAdministration:patient", "MedicationDispense:patient", "MedicationRequest:patient", "MedicationStatement:patient", "NutritionOrder:patient", "Observation:patient", "Procedure:patient", "RiskAssessment:patient", "ServiceRequest:patient", "SupplyDelivery:patient", "VisionPrescription:patient" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id", "type": "token", "documentation": "Logical id of this artifact
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer conformance expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - comparator
\n - modifier
\n - chain
" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "active", "definition": "http://hl7.org/fhir/SearchParameter/Patient-active", "type": "token", "documentation": "Whether the patient record is active" }, { "name": "address", "definition": "http://hl7.org/fhir/SearchParameter/individual-address", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "address-city", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-city", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address" }, { "name": "address-country", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-country", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address" }, { "name": "address-postalcode", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address" }, { "name": "address-state", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-state", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address" }, { "name": "address-use", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-use", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address" }, { "name": "birthdate", "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth" }, { "name": "death-date", "definition": "http://hl7.org/fhir/SearchParameter/Patient-death-date", "type": "date", "documentation": "The date of death has been provided and satisfies this search value" }, { "name": "deceased", "definition": "http://hl7.org/fhir/SearchParameter/Patient-deceased", "type": "token", "documentation": "This patient has been marked as deceased, or as a death date entered" }, { "name": "email", "definition": "http://hl7.org/fhir/SearchParameter/individual-email", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" }, { "name": "ethnicity", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-ethnicity", "type": "token", "documentation": "Returns patients with an ethnicity extension matching the specified code." }, { "name": "family", "definition": "http://hl7.org/fhir/SearchParameter/individual-family", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name" }, { "name": "gender", "definition": "http://hl7.org/fhir/SearchParameter/individual-gender", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person" }, { "name": "general-practitioner", "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner", "type": "reference", "documentation": "Patient's nominated general practitioner, not the organization that manages the record" }, { "name": "given", "definition": "http://hl7.org/fhir/SearchParameter/individual-given", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier", "type": "token", "documentation": "A patient identifier" }, { "name": "language", "definition": "http://hl7.org/fhir/SearchParameter/Patient-language", "type": "token", "documentation": "Language code (irrespective of use value)" }, { "name": "link", "definition": "http://hl7.org/fhir/SearchParameter/Patient-link", "type": "reference", "documentation": "All patients linked to the given patient" }, { "name": "name", "definition": "http://hl7.org/fhir/SearchParameter/Patient-name", "type": "string", "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text" }, { "name": "organization", "definition": "http://hl7.org/fhir/SearchParameter/Patient-organization", "type": "reference", "documentation": "The organization that is the custodian of the patient record" }, { "name": "phone", "definition": "http://hl7.org/fhir/SearchParameter/individual-phone", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" }, { "name": "phonetic", "definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm" }, { "name": "race", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-race", "type": "token", "documentation": "Returns patients with a race extension matching the specified code." }, { "name": "telecom", "definition": "http://hl7.org/fhir/SearchParameter/individual-telecom", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Practitioner", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner", "http://hl7.org/fhir/StructureDefinition/Practitioner" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchRevInclude": [ "Account:subject", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:recorder", "AdverseEvent:subject", "AllergyIntolerance:asserter", "AllergyIntolerance:recorder", "Appointment:actor", "Appointment:practitioner", "Appointment:supporting-info", "AppointmentResponse:actor", "AppointmentResponse:practitioner", "AuditEvent:agent", "AuditEvent:entity", "AuditEvent:source", "Basic:author", "Basic:subject", "CarePlan:performer", "CareTeam:participant", "ChargeItem:enterer", "ChargeItem:performer-actor", "Claim:care-team", "Claim:enterer", "Claim:payee", "Claim:provider", "ClaimResponse:requestor", "ClinicalImpression:assessor", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:recipient", "Communication:sender", "CommunicationRequest:based-on", "CommunicationRequest:recipient", "CommunicationRequest:requester", "CommunicationRequest:sender", "Composition:attester", "Composition:author", "Composition:entry", "Composition:subject", "Condition:asserter", "Condition:evidence-detail", "Consent:actor", "Consent:consentor", "Consent:data", "Contract:signer", "Contract:subject", "CoverageEligibilityRequest:enterer", "CoverageEligibilityRequest:provider", "CoverageEligibilityResponse:requestor", "DetectedIssue:author", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:performer", "DeviceRequest:prior-request", "DeviceRequest:requester", "DiagnosticReport:performer", "DiagnosticReport:results-interpreter", "DocumentManifest:author", "DocumentManifest:item", "DocumentManifest:recipient", "DocumentManifest:related-ref", "DocumentManifest:subject", "DocumentReference:authenticator", "DocumentReference:author", "DocumentReference:related", "DocumentReference:subject", "Encounter:participant", "Encounter:practitioner", "EpisodeOfCare:care-manager", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:care-team", "ExplanationOfBenefit:enterer", "ExplanationOfBenefit:payee", "ExplanationOfBenefit:provider", "Flag:author", "Flag:subject", "Group:managing-entity", "Group:member", "ImagingStudy:interpreter", "ImagingStudy:performer", "ImagingStudy:referrer", "Immunization:performer", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Invoice:participant", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:author", "Linkage:item", "Linkage:source", "List:item", "List:source", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MeasureReport:reporter", "MeasureReport:subject", "Media:operator", "Media:subject", "MedicationAdministration:performer", "MedicationDispense:performer", "MedicationDispense:receiver", "MedicationDispense:responsibleparty", "MedicationRequest:intended-performer", "MedicationRequest:requester", "MedicationStatement:source", "MessageHeader:author", "MessageHeader:enterer", "MessageHeader:focus", "MessageHeader:receiver", "MessageHeader:responsible", "MessageHeader:sender", "NutritionOrder:provider", "Observation:focus", "Observation:performer", "Patient:general-practitioner", "PaymentNotice:provider", "PaymentNotice:request", "PaymentNotice:response", "PaymentReconciliation:requestor", "Person:link", "Person:practitioner", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "PractitionerRole:practitioner", "Procedure:performer", "Provenance:agent", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:author", "QuestionnaireResponse:source", "QuestionnaireResponse:subject", "RequestGroup:author", "RequestGroup:participant", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ResearchStudy:principalinvestigator", "RiskAssessment:performer", "Schedule:actor", "ServiceRequest:performer", "ServiceRequest:requester", "Specimen:collector", "SupplyDelivery:receiver", "SupplyDelivery:supplier", "SupplyRequest:requester", "Task:based-on", "Task:focus", "Task:owner", "Task:requester", "Task:subject", "VerificationResult:target", "VisionPrescription:prescriber" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "active", "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-active", "type": "token", "documentation": "Whether the practitioner record is active" }, { "name": "address", "definition": "http://hl7.org/fhir/SearchParameter/individual-address", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "address-city", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-city", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address" }, { "name": "address-country", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-country", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address" }, { "name": "address-postalcode", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address" }, { "name": "address-state", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-state", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address" }, { "name": "address-use", "definition": "http://hl7.org/fhir/SearchParameter/individual-address-use", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address" }, { "name": "communication", "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-communication", "type": "token", "documentation": "One of the languages that the practitioner can communicate with" }, { "name": "email", "definition": "http://hl7.org/fhir/SearchParameter/individual-email", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" }, { "name": "family", "definition": "http://hl7.org/fhir/SearchParameter/individual-family", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name" }, { "name": "gender", "definition": "http://hl7.org/fhir/SearchParameter/individual-gender", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person" }, { "name": "given", "definition": "http://hl7.org/fhir/SearchParameter/individual-given", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-identifier", "type": "token", "documentation": "A practitioner's Identifier" }, { "name": "name", "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-name", "type": "string", "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text" }, { "name": "phone", "definition": "http://hl7.org/fhir/SearchParameter/individual-phone", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" }, { "name": "phonetic", "definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic", "type": "string", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm" }, { "name": "telecom", "definition": "http://hl7.org/fhir/SearchParameter/individual-telecom", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Procedure", "profile": "http://hl7.org/fhir/StructureDefinition/Procedure", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure", "http://hl7.org/fhir/StructureDefinition/Procedure" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Procedure:encounter", "Procedure:based-on", "Procedure:instantiates-canonical", "Procedure:location", "Procedure:part-of", "Procedure:performer", "Procedure:reason-reference", "Procedure:subject", "Procedure:patient" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:substance", "Appointment:reason-reference", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:service", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:diagnosis", "Encounter:reason-reference", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "Flag:subject", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MedicationStatement:part-of", "MessageHeader:focus", "Observation:focus", "Observation:part-of", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:part-of", "Procedure:reason-reference", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:part-of", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "based-on", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-based-on", "type": "reference", "documentation": "A request for this procedure" }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-category", "type": "token", "documentation": "Classification of the procedure" }, { "name": "code", "definition": "http://hl7.org/fhir/SearchParameter/clinical-code", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered" }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made" }, { "name": "encounter", "definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier" }, { "name": "identifier", "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type": "token", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier" }, { "name": "instantiates-canonical", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-instantiates-canonical", "type": "reference", "documentation": "Instantiates FHIR protocol or definition" }, { "name": "instantiates-uri", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-instantiates-uri", "type": "uri", "documentation": "Instantiates external protocol or definition" }, { "name": "location", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-location", "type": "reference", "documentation": "Where the procedure happened" }, { "name": "part-of", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-part-of", "type": "reference", "documentation": "Part of referenced event" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "performer", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-performer", "type": "reference", "documentation": "The reference to the practitioner" }, { "name": "reason-code", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-reason-code", "type": "token", "documentation": "Coded reason procedure performed" }, { "name": "reason-reference", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-reason-reference", "type": "reference", "documentation": "The justification that the procedure was performed" }, { "name": "status", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-status", "type": "token", "documentation": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown" }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/Procedure-subject", "type": "reference", "documentation": "Search by subject" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] }, { "type": "Provenance", "profile": "http://hl7.org/fhir/StructureDefinition/Provenance", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance", "http://hl7.org/fhir/StructureDefinition/Provenance", "http://hl7.org/fhir/StructureDefinition/ehrsrle-provenance", "http://hl7.org/fhir/StructureDefinition/provenance-relevant-history" ], "interaction": [ { "code": "history-instance" }, { "code": "history-type" }, { "code": "patch" }, { "code": "read" }, { "code": "search-type" }, { "code": "vread" } ], "versioning": "versioned", "readHistory": true, "conditionalCreate": false, "conditionalRead": "full-support", "conditionalUpdate": false, "conditionalDelete": "not-supported", "searchInclude": [ "Provenance:agent", "Provenance:entity", "Provenance:location", "Provenance:patient", "Provenance:target" ], "searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "agent", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-agent", "type": "reference", "documentation": "Who participated" }, { "name": "agent-role", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-agent-role", "type": "token", "documentation": "What the agents role was" }, { "name": "agent-type", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-agent-type", "type": "token", "documentation": "How the agent participated" }, { "name": "entity", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-entity", "type": "reference", "documentation": "Identity of entity" }, { "name": "location", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-location", "type": "reference", "documentation": "Where the activity occurred, if relevant" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-patient", "type": "reference", "documentation": "Target Reference(s) (usually version specific)" }, { "name": "recorded", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-recorded", "type": "date", "documentation": "When the activity was recorded / updated" }, { "name": "signature-type", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-signature-type", "type": "token", "documentation": "Indication of the reason the entity signed the object(s)" }, { "name": "target", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-target", "type": "reference", "documentation": "Target Reference(s) (usually version specific)" }, { "name": "when", "definition": "http://hl7.org/fhir/SearchParameter/Provenance-when", "type": "date", "documentation": "When the activity occurred" } ], "operation": [ { "name": "meta-add", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add" } ] } ], "interaction": [ { "code": "batch" }, { "code": "history-system" }, { "code": "search-system" }, { "code": "transaction" } ], "searchParam": [ { "name": "_count", "type": "number", "documentation": "The number of resources returned per page" }, { "name": "_format", "type": "string", "documentation": "Specify the returned format of the payload response" }, { "name": "_has", "type": "string", "documentation": "Enables querying a reverse chain" }, { "name": "_id", "definition": "http://hl7.org/fhir/SearchParameter/Resource-id", "type": "token", "documentation": "Logical id of this artifact" }, { "name": "_lastUpdated", "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated", "type": "date", "documentation": "When the resource version last changed" }, { "name": "_profile", "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile", "type": "uri", "documentation": "Profiles this resource claims to conform to" }, { "name": "_security", "definition": "http://hl7.org/fhir/SearchParameter/Resource-security", "type": "token", "documentation": "Security Labels applied to this resource" }, { "name": "_source", "definition": "http://hl7.org/fhir/SearchParameter/Resource-source", "type": "uri", "documentation": "Identifies where the resource comes from" }, { "name": "_tag", "definition": "http://hl7.org/fhir/SearchParameter/Resource-tag", "type": "token", "documentation": "Tags applied to this resource" }, { "name": "_type", "type": "string", "documentation": "Enables querying for a type of resource" } ], "operation": [ { "name": "convert", "definition": "http://vonk.fire.ly/fhir/OperationDefinition/Resource-convert" }, { "name": "document", "definition": "http://hl7.org/fhir/OperationDefinition/Composition-document" }, { "name": "expand", "definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand" }, { "name": "find-matches", "definition": "http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches" }, { "name": "lookup", "definition": "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup" }, { "name": "meta", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta" }, { "name": "snapshot", "definition": "http://vonk.fire.ly/OperationDefinition/Snapshot-expand" }, { "name": "subsumes", "definition": "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes" }, { "name": "translate", "definition": "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate" }, { "name": "validate", "definition": "http://vonk.fire.ly/fhir/OperationDefinition/Resource-validate-instance" }, { "name": "validate", "definition": "http://hl7.org/fhir/OperationDefinition/Resource-validate" }, { "name": "validate", "definition": "http://vonk.fire.ly/OperationDefinition/Resource-validate-system" }, { "name": "validate-code", "definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code" } ] } ] }

Device

readDevice

read: Read a FHIR Device

/Device/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Device/6f66eb69-5e5d-414e-bd0c-20f8c5b3ccf5

searchDeviceGet

search-type: Search for Device by Patient

/Device?patient=[patient]
Query parameters

Parameters

Name Description
patient*
String
Individual the service is ordered for
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Device?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Device by Patient and Type

/Device?patient=[patient]&type={system|}[code]
Query parameters

Parameters

Name Description
patient*
String
Individual the service is ordered for
Required
type*
String
The type of the device
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Device?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&type=704707009

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T23:54:56.474+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T23:54:56.474+00:00",
        "versionId": "73621e19-9f0a-4b1c-b606-291dc900074d"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Device/6f66eb69-5e5d-414e-bd0c-20f8c5b3ccf5",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Device",
                "id": "6f66eb69-5e5d-414e-bd0c-20f8c5b3ccf5",
                "udiCarrier": [
                    {
                        "deviceIdentifier": "fgg6789",
                        "carrierHRF": "=/A9999XYZ100T0944=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123,"
                    }
                ],
                "status": "active",
                "distinctIdentifier": "A99971312345600",
                "manufacturer": "CompanyName",
                "manufactureDate": "2022-08-31T16:59:56.637-06:00",
                "lotNumber": "8765erasd",
                "serialNumber": "ty45ghj",
                "modelNumber": "Version",
                "type": {
                    "text": "GMDN PT NAME"
                },
                "patient": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "meta": {
                    "versionId": "23fa7f20-4cd5-48d7-93f7-4c3880676510",
                    "lastUpdated": "2022-10-26T18:47:48.660+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Device/fbffaa45-c912-408a-8af3-86ee6df41ec8",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Device",
                "id": "fbffaa45-c912-408a-8af3-86ee6df41ec8",
                "udiCarrier": [
                    {
                        "deviceIdentifier": "00643169007222",
                        "carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"
                    }
                ],
                "status": "active",
                "manufacturer": "MEDTRONIC, INC.",
                "expirationDate": "2016-01-28T00:00:00-07:00",
                "serialNumber": "BLC200461H",
                "modelNumber": "DTBA1QQ",
                "type": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "704707009",
                            "display": "Cardiac resynchronization therapy implantable defibrillator (physical object)"
                        }
                    ],
                    "text": "Cardiac resynchronization therapy implantable defibrillator"
                },
                "patient": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "meta": {
                    "versionId": "0b387d6a-28c4-4496-824a-a97a511f87e0",
                    "lastUpdated": "2022-10-26T18:47:47.877+00:00"
                }
            }
        }
    ],
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Device?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "dcfb6ed4-9a90-4812-8c8c-4ad94a77a161"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

DiagnosticReport

readDiagnosticReport

read: Read a FHIR DiagnosticReport

/DiagnosticReport/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /DiagnosticReport/RNE-26224f28-a93e-42b6-b90f-e47f584073fb

searchDiagnosticReportGet

search-type: Search for DiagnosticReport by Patient

/DiagnosticReport?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
The subject of the report if a patient
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for DiagnosticReport by Patient and Category

/DiagnosticReport?patient=[patient]&category={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The subject of the report if a patient
Required
category*
String
Type of plan
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=LAB

search-type: Search for DiagnosticReport by Patient and Code

/DiagnosticReport?patient=[patient]&code={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The subject of the report if a patient
Required
code*
String
The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&code=24357-6

search-type: Search for DiagnosticReport by Patient, Category and Date

/DiagnosticReport?patient=[patient]&category={system|}[code]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
The subject of the report if a patient
Required
category*
String
Type of plan
Required
date*
String
The clinically relevant time of the report
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=LAB&date=ge2001-01-01

search-type: Search for DiagnosticReport by Patient and Status

/DiagnosticReport?patient=[patient]&status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The subject of the report if a patient
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&status=active

search-type: Search for DiagnosticReport by Patient, Code and Date

/DiagnosticReport?patient=[patient]&code={system|}[code]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
The subject of the report if a patient
Required
code*
String
The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
Required
date*
String
The clinically relevant time of the report
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&code=24357-6&date=ge2001-01-01

Responses

Status: 200 - Success

								  
{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T19:02:11.263+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T19:02:11.263+00:00",
        "versionId": "a8435c39-a3b8-42cd-a9ab-484303576dce"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/DiagnosticReport/9878590b-fa14-4b60-a4c5-b5bc915a849c",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "DiagnosticReport",
                "id": "9878590b-fa14-4b60-a4c5-b5bc915a849c",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                                "code": "LAB",
                                "display": "Laboratory"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "24357-6",
                            "display": "Urinalysis macro (dipstick) panel"
                        }
                    ],
                    "text": "Urinalysis macro (dipstick) panel"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2015-06-22T08:34:34-06:00",
                "issued": "2015-06-22T08:34:34-06:00",
                "performer": [
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Organization/45c123df-fa7d-4dcc-abf8-d45a328ffbd9",
                        "display": "Walgreens"
                    }
                ],
                "result": [
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/eb2f85f6-33fc-4484-afa3-8ca61eaf10cc",
                        "display": "Protein in urine by test strip"
                    },
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/665c98a6-b077-4f8f-ad97-ab676562ef3c",
                        "display": "Keytones in urine by test strip"
                    },
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/eb66b77c-41b7-4f36-a002-73ce35d0e3bd",
                        "display": "Glucose in urine by test strip"
                    },
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/79c4c685-9b00-480c-b467-12a2bd5674b7",
                        "display": "pH of Urine by test strip"
                    },
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/1fb9dd7c-4495-4dc8-a36a-00747a5b6d39",
                        "display": "Specific gravity of Urine by Test strip"
                    },
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/54d80399-788b-42f7-a434-1938770b3c45",
                        "display": "Appearance of Urine"
                    },
                    {
                        "reference": "https://firely01dev.azurewebsites.net/Observation/715f9118-8c3f-41bb-8f6c-235f6c2cf78d",
                        "display": "Color of Urine"
                    }
                ],
                "meta": {
                    "versionId": "ca97384c-8dbe-46b8-a293-3795c39fbe5d",
                    "lastUpdated": "2022-10-26T18:49:37.768+00:00"
                }
            }
        }
    ],
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/DiagnosticReport?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "b6025016-9977-4496-b72f-efd4fb357f3f"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

DocumentReference

readDocumentReference

read: Read a FHIR DocumentReference

/DocumentReference/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /DocumentReference/DR-d4e77a35-9961-4860-b30d-162b66723cbd

searchDocumentReferenceGet

search-type: Search for DocumentReference by Id

/DocumentReference?_id=[id]

Parameters

Query parameters
Name Description
_id*
String
Master Version Specific Identifier
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?_id=DR-d4e77a35-9961-4860-b30d-162b66723cbd

search-type: Search for DocumentReference by Patient

/DocumentReference?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
Who/what is the subject of the document
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for DocumentReference by Patient and Category

/DocumentReference?patient=[patient]&category={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who/what is the subject of the document
Required
category*
String
Type of plan
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=clinical-note

search-type: Search for DocumentReference by Patient, Category and Date

/DocumentReference?patient=[patient]&category={system|}[code]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Who/what is the subject of the document
Required
category*
String
Type of plan
Required
date*
String
Time of service that is being documented
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=clinical-note&date=ge2001-01-01

search-type: Search for DocumentReference by Patient and Type

/DocumentReference?patient=[patient]&type={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who/what is the subject of the document
Required
type*
String
The type of the device
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&type=34133-9

search-type: Search for DocumentReference by Patient and Status

/DocumentReference?patient=[patient]&status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who/what is the subject of the document
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&status=active

search-type: Search for DocumentReference by Patient, Type and Period

/DocumentReference?patient=[patient]&type={system|}[code]&period={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Who/what is the subject of the document
Required
type*
String
The type of the device
Required
period*
String
Time of service that is being documented
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /DocumentReference?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&type=&period=ge2001-01-01

Responses

Status: 200 - Success


{
    "resourceType": "DocumentReference",
    "id": "DR-a7a32ebc-ca31-4c3b-8555-d02c1e679ec2",
    "identifier": [
        {
            "system": "http://www.elekta.com/ids/document",
            "value": "DR-a7a32ebc-ca31-4c3b-8555-d02c1e679ec2"
        }
    ],
    "status": "current",
    "type": {
        "coding": [
            {
                "system": "http://loinc.org",
                "code": "34133-9",
                "display": "Summary of episode note"
            }
        ]
    },
    "category": [
        {
            "coding": [
                {
                    "system": "http://elekta.com/FHIR/document-category",
                    "code": "CCDA",
                    "display": "Clinical Summary of Care"
                }
            ]
        }
    ],
    "subject": {
        "reference": "https://firely01elektacert.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
        "display": "Newman, Alice Jones"
    },
    "date": "2022-11-28T17:53:07.697+00:00",
    "author": [
        {
            "reference": "https://firely01elektacert.azurewebsites.net/Practitioner/a320ba5e-265c-4a69-bfff-af0aea645bab",
            "display": "Davis, Albert"
        }
    ],
    "custodian": {
        "reference": "https://firely01elektacert.azurewebsites.net/Organization/5c4a9fbf-28bb-4d8f-b5b0-6448857e2e17",
        "display": "Sunnyvale Radiation Oncology"
    },
    "content": [
        {
            "attachment": {
                "contentType": "application/xml",
                "data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48P3htbC1zdHlsZXNoZWV0IHR5cGU9J3RleHQveHNsdDREEueHNsJz8=="
            },
            "format": {
                "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
                "code": "urn:hl7-org:sdwg:ccda-structuredBody:2.1",
                "display": "Documents following C-CDA constraints using a structured body"
            }
        }
    ],
    "context": {
        "period": {
            "start": "2016-10-07T08:45:00+00:00",
            "end": "2022-11-28T23:59:59+00:00"
        }
    }
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Encounter

readEncounter

read: Read a FHIR Encounter

/Encounter/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Encounter/54df5a9a-dc13-4255-ac27-67420adf289d

searchEncounterGet

search-type: Search for Encounter by Id

/Encounter?_id=[id]

Parameters

Query parameters
Name Description
_id*
String
Identifier(s) by which this encounter is known
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Encounter?_id=54df5a9a-dc13-4255-ac27-67420adf289d

search-type: Search for Encounter by Patient

/Encounter?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
The patient or group present at the encounter
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Encounter?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Encounter by Date and Patient

GET /Encounter?date={gt|lt|ge|le}[date]&patient=[patient]

Parameters

Query parameters
Name Description
date*
String
Time of service
Required
patient*
String
The patient or group present at the encounter
Required
_revinclude

Request

GET /Encounter?date=ge2001-01-01&patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Encounter by Identifier

/Encounter?identifier={system|}[code]

Parameters

Query parameters
Name Description
identifier*
String
Identifier(s) by which this encounter is known
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Encounter?identifier=54df5a9a-dc13-4255-ac27-67420adf289d

search-type: Search for Encounter by Class and Patient

/Encounter?class={system|}[code]&patient=[patient]

Parameters

Query parameters
Name Description
class*
String
Classification of patient encounter
Required
patient*
String
The patient or group present at the encounter
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Encounter?class=AMB&patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Encounter by Patient and Type

/Encounter?patient=[patient]&type={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The patient or group present at the encounter
Required
type*
String
The type of the device
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Encounter?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&type=99243

search-type: Search for Encounter by Patient and Status

/Encounter?patient=[patient]&status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The patient or group present at the encounter
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Encounter?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&status=completed

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T19:11:52.041+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T19:11:52.041+00:00",
        "versionId": "666cf83f-b469-4dd2-b1ac-77163ab44742"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Encounter/54df5a9a-dc13-4255-ac27-67420adf289d",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Encounter",
                "id": "54df5a9a-dc13-4255-ac27-67420adf289d",
                "identifier": [
                    {
                        "system": "http://www.elekta.com/ids/encounter",
                        "value": "54df5a9a-dc13-4255-ac27-67420adf289d"
                    }
                ],
                "status": "finished",
                "class": {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                    "code": "AMB",
                    "display": "ambulatory"
                },
                "type": [
                    {
                        "coding": [
                            {
                                "system": "http://www.ama-assn.org/go/cpt",
                                "code": "99243",
                                "display": "Outpatient Consultation: 3"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "participant": [
                    {
                        "type": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                                        "code": "PART"
                                    }
                                ],
                                "text": "Participation"
                            }
                        ],
                        "period": {
                            "start": "2015-06-22",
                            "end": "2015-06-22"
                        },
                        "individual": {
                            "reference": "https://firely01dev.azurewebsites.net/Practitioner/4BBBB756-AD0A-45A1-8D51-049D3630F1EE",
                            "display": "Davis, Albert"
                        }
                    }
                ],
                "period": {
                    "start": "2015-06-22",
                    "end": "2015-06-22"
                },
                "reasonCode": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                "code": "unknown",
                                "display": "unknown"
                            }
                        ]
                    }
                ],
                "hospitalization": {
                    "dischargeDisposition": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                "code": "unknown",
                                "display": "unknown"
                            }
                        ]
                    }
                },
                "meta": {
                    "versionId": "8d209990-aae0-432e-8504-03a5b6744e83",
                    "lastUpdated": "2022-11-03T22:01:04.874+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Encounter/010e4546-04d8-4ac2-8505-7a93c1b70cdf",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Encounter",
                "id": "010e4546-04d8-4ac2-8505-7a93c1b70cdf",
                "identifier": [
                    {
                        "system": "http://www.elekta.com/ids/encounter",
                        "value": "010e4546-04d8-4ac2-8505-7a93c1b70cdf"
                    }
                ],
                "status": "finished",
                "class": {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                    "code": "AMB",
                    "display": "ambulatory"
                },
                "type": [
                    {
                        "coding": [
                            {
                                "system": "http://www.ama-assn.org/go/cpt",
                                "code": "99241",
                                "display": "Outpatient Consultation: 1"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "participant": [
                    {
                        "type": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                                        "code": "PART"
                                    }
                                ],
                                "text": "Participation"
                            }
                        ],
                        "period": {
                            "start": "2022-03-15",
                            "end": "2022-03-15"
                        },
                        "individual": {
                            "reference": "https://firely01dev.azurewebsites.net/Practitioner/a320ba5e-265c-4a69-bfff-af0aea645bab",
                            "display": "Davis, Albert"
                        }
                    }
                ],
                "period": {
                    "start": "2022-03-15",
                    "end": "2022-03-15"
                },
                "reasonCode": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                "code": "unknown",
                                "display": "unknown"
                            }
                        ]
                    }
                ],
                "hospitalization": {
                    "dischargeDisposition": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                "code": "unknown",
                                "display": "unknown"
                            }
                        ]
                    }
                },
                "location": [
                    {
                        "location": {
                            "reference": "https://firely01dev.azurewebsites.net/Location/c4a8cb3e-8f59-4b19-b80d-5ac98d4d0874",
                            "display": "Conference Room 1"
                        }
                    }
                ],
                "meta": {
                    "versionId": "3027ea73-1cfa-4bc0-8ff9-b07ad00a99e8",
                    "lastUpdated": "2022-10-26T18:48:29.837+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Encounter/31d86fd2-7db6-444d-8351-6190a35b2fdd",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Encounter",
                "id": "31d86fd2-7db6-444d-8351-6190a35b2fdd",
                "identifier": [
                    {
                        "system": "http://www.elekta.com/ids/encounter",
                        "value": "31d86fd2-7db6-444d-8351-6190a35b2fdd"
                    }
                ],
                "status": "finished",
                "class": {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                    "code": "AMB",
                    "display": "ambulatory"
                },
                "type": [
                    {
                        "coding": [
                            {
                                "system": "http://www.ama-assn.org/go/cpt",
                                "code": "99241",
                                "display": "Outpatient Consultation: 1"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "participant": [
                    {
                        "type": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                                        "code": "PART"
                                    }
                                ],
                                "text": "Participation"
                            }
                        ],
                        "period": {
                            "start": "2017-02-28",
                            "end": "2017-02-28"
                        },
                        "individual": {
                            "reference": "https://firely01dev.azurewebsites.net/Practitioner/a320ba5e-265c-4a69-bfff-af0aea645bab",
                            "display": "Davis, Albert"
                        }
                    }
                ],
                "period": {
                    "start": "2017-02-28",
                    "end": "2017-02-28"
                },
                "reasonCode": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                "code": "unknown",
                                "display": "unknown"
                            }
                        ]
                    }
                ],
                "hospitalization": {
                    "dischargeDisposition": {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                "code": "unknown",
                                "display": "unknown"
                            }
                        ]
                    }
                },
                "location": [
                    {
                        "location": {
                            "reference": "https://firely01dev.azurewebsites.net/Location/c4a8cb3e-8f59-4b19-b80d-5ac98d4d0874",
                            "display": "Conference Room 1"
                        }
                    }
                ],
                "meta": {
                    "versionId": "4c93fb8f-50ab-489e-9662-89ef701d606d",
                    "lastUpdated": "2022-10-26T18:48:27.291+00:00"
                }
            }
        }
    ],
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Encounter?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "637426f2-a15a-41e9-b93d-8a3ffd0ce167"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Goal

readGoal

read: Read a FHIR Goal

/Goal/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Goal/99b7abd9-4440-4f3d-8756-8c48e3485d16

searchGoalGet

search-type: Search for Goal by Patient

/Goal?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
Who this goal is intended for
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Goal?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Goal by Patient and Lifecycle Status

/Goal?patient=[patient]&lifecycle-status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Who this goal is intended for
Required
lifecycle-status*
String
proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Goal?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&lifecycle-status=active

search-type: Search for Goal by Patient and Target Date

/Goal?patient=[patient]&target-date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Who this goal is intended for
Required
target-date*
String
Date to reach goal on or before
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Goal?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&target-date=ge2001-01-01

Responses

Status: 200 - Success

								  
{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T23:49:19.924+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T23:49:19.924+00:00",
        "versionId": "787e9824-f1dc-4e0c-8555-6f2774f48784"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Goal/99b7abd9-4440-4f3d-8756-8c48e3485d16",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Goal",
                "id": "99b7abd9-4440-4f3d-8756-8c48e3485d16",
                "lifecycleStatus": "proposed",
                "description": {
                    "text": "Weight loss\r\nLose Weight"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "target": [
                    {
                        "dueDate": "2022-08-31"
                    }
                ],
                "statusDate": "2022-08-31",
                "meta": {
                    "versionId": "85fef928-66d0-4d57-bd2e-d05272d764f9",
                    "lastUpdated": "2022-10-26T18:49:56.329+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Goal/91516ccd-ec43-4655-a8b0-3fe2e87431cb",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Goal",
                "id": "91516ccd-ec43-4655-a8b0-3fe2e87431cb",
                "lifecycleStatus": "active",
                "description": {
                    "text": "a. Get rid of intermittent fever that is ocurring every few weeks.\r\nb. Need to gain more energy to do regular activities."
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "target": [
                    {
                        "_dueDate": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ]
                        }
                    }
                ],
                "statusDate": "2015-06-22",
                "meta": {
                    "versionId": "35485e40-3895-4388-ad9f-39656a7b6502",
                    "lastUpdated": "2022-10-26T18:49:45.899+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Goal/5bb2dbe2-c633-40a3-9978-865ca6628651",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Goal",
                "id": "5bb2dbe2-c633-40a3-9978-865ca6628651",
                "lifecycleStatus": "entered-in-error",
                "description": {
                    "text": "a. Get rid of intermittent fever that is ocurring every few weeks.\r\nb. Need to gain more energy to do regular activities."
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "target": [
                    {
                        "_dueDate": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ]
                        }
                    }
                ],
                "statusDate": "2015-06-22",
                "meta": {
                    "versionId": "38bd4038-09f4-446e-b25e-242627d4a339",
                    "lastUpdated": "2022-10-26T18:49:38.544+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Goal/bf1ce55e-c907-4a82-96dd-6f55c04f7626",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Goal",
                "id": "bf1ce55e-c907-4a82-96dd-6f55c04f7626",
                "lifecycleStatus": "proposed",
                "description": {
                    "text": "Get rid of intermittent fever that is occurring every few weeks."
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "target": [
                    {
                        "_dueDate": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ]
                        }
                    }
                ],
                "statusDate": "2015-06-22",
                "meta": {
                    "versionId": "10fbe134-1e7c-406e-93a4-9a96372bb12a",
                    "lastUpdated": "2022-10-26T18:47:56.027+00:00"
                }
            }
        }
    ],
    "total": 4,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Goal?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "a3d828da-0650-4fd2-88a6-b6f3108b4225"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Immunization

readImmunization

read: Read a FHIR Immunization

/Immunization/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Immunization/3b2c5bfe-3748-4f81-8d88-2565c30e76e3

searchImmunizationGet

search-type: Search for Immunization by Patient

/Immunization?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
The patient for the vaccination record
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Immunization?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Immunization by Patient and Date

/Immunization?patient=[patient]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
The patient for the vaccination record
Required
date*
String
Vaccination (non)-Administration Date
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Immunization?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&date=ge2001-01-01

search-type: Search for Immunization by Patient and Status

/Immunization?patient=[patient]&status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The patient for the vaccination record
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Immunization?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&status=active

Responses

Status: 200 - Success

								  
{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T23:51:31.249+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T23:51:31.249+00:00",
        "versionId": "601b397e-a4f7-4404-b717-6567e5e403bc"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Immunization/3b2c5bfe-3748-4f81-8d88-2565c30e76e3",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Immunization",
                "id": "3b2c5bfe-3748-4f81-8d88-2565c30e76e3",
                "status": "entered-in-error",
                "statusReason": {
                    "text": "Patient decision"
                },
                "vaccineCode": {
                    "coding": [
                        {
                            "system": "http://hl7.org/fhir/sid/cvx",
                            "code": "166",
                            "display": "Influenza, intradermal, quadrivalent"
                        }
                    ]
                },
                "patient": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "occurrenceDateTime": "2015-06-22T00:00:00-06:00",
                "primarySource": false,
                "meta": {
                    "versionId": "8967efde-1d29-419e-92df-a316488db5be",
                    "lastUpdated": "2022-10-26T18:49:02.524+00:00"
                }
            }
        }
    ],
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Immunization?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "072ff86f-2d21-432a-bdc0-e41bcd1a5943"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Location

readLocation

read: Read a FHIR Location

/Location/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Location/5E017B8D-FD7C-4C5A-BE86-13717EDF0957

searchLocationGet

search-type: Search for Location by Name

/Location?name=[string]

Parameters

Query parameters
Name Description
name*
String
A portion of the location's name or alias
Required

Request

GET /Location?name=Conference Room 1

search-type: Search for Location by Address

/Location?address=[string]

Parameters

Query parameters
Name Description
address*
String
A (part of the) address of the location
Required

Request

GET /Location?address=100 Mathilda Place

search-type: Search for Location by Address City

/Location?address-city=[string]

Parameters

Query parameters
Name Description
address-city
String
A city specified in an address

Request

GET /Location?address-city=Sunnyvale

search-type: Search for Location by Address State

/Location?address-state=[string]

Parameters

Query parameters
Name Description
address-state
String
A state specified in an address

Request

GET /Location?address-state=CA

search-type: Search for Location by Address PostalCode

/Location?address-postalcode=[string]

Parameters

Query parameters
Name Description
address-postalcode
String
A postal code specified in an address

Request

GET /Location?address-postalcode=94086

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T23:59:56.083+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T23:59:56.083+00:00",
        "versionId": "9409ded6-5cfe-47f0-a643-cc7f63189205"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Location/5E017B8D-FD7C-4C5A-BE86-13717EDF0957",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Location",
                "id": "5E017B8D-FD7C-4C5A-BE86-13717EDF0957",
                "identifier": [
                    {
                        "type": {
                            "text": "ESI"
                        },
                        "value": "MITCHELL80"
                    }
                ],
                "status": "active",
                "name": "Conference Room 1",
                "telecom": [
                    {
                        "system": "phone",
                        "value": "800-488-4672"
                    },
                    {
                        "system": "email",
                        "value": "support@impac.com"
                    }
                ],
                "address": {
                    "line": [
                        "100 Mathilda Place"
                    ],
                    "city": "Sunnyvale",
                    "state": "CA",
                    "postalCode": "94086",
                    "country": "USA"
                },
                "managingOrganization": {
                    "reference": "https://firely01dev.azurewebsites.net/Organization/431A52DB-8504-4DEE-9312-AFC23505946A",
                    "display": "Sunnyvale Medical Oncology"
                },
                "meta": {
                    "versionId": "865a6aab-2791-4e9e-af42-5a6fc3ce6080",
                    "lastUpdated": "2022-11-07T21:59:19.922+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Location/c4a8cb3e-8f59-4b19-b80d-5ac98d4d0874",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Location",
                "id": "c4a8cb3e-8f59-4b19-b80d-5ac98d4d0874",
                "identifier": [
                    {
                        "type": {
                            "text": "ESI"
                        },
                        "value": "MITCHELL80"
                    }
                ],
                "status": "active",
                "name": "Conference Room 1",
                "telecom": [
                    {
                        "system": "phone",
                        "value": "800-488-4672"
                    },
                    {
                        "system": "email",
                        "value": "support@impac.com"
                    }
                ],
                "address": {
                    "line": [
                        "100 Mathilda Place"
                    ],
                    "city": "Sunnyvale",
                    "state": "CA",
                    "postalCode": "94086",
                    "country": "USA"
                },
                "managingOrganization": {
                    "reference": "https://firely01dev.azurewebsites.net/Organization/4da3b06a-837c-4009-a6ad-f21c994ed43c",
                    "display": "Sunnyvale Medical Oncology"
                },
                "meta": {
                    "versionId": "05389ca2-cfde-4852-93b3-c3bfdab66e03",
                    "lastUpdated": "2022-10-26T18:47:59.413+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Location/92710567-3f90-4213-aa5e-6f4838659845",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Location",
                "id": "92710567-3f90-4213-aa5e-6f4838659845",
                "identifier": [
                    {
                        "type": {
                            "text": "ESI"
                        },
                        "value": "MITCHELL80"
                    }
                ],
                "status": "active",
                "name": "Conference Room 1",
                "telecom": [
                    {
                        "system": "phone",
                        "value": "800-488-4672"
                    },
                    {
                        "system": "email",
                        "value": "support@impac.com"
                    }
                ],
                "address": {
                    "line": [
                        "100 Mathilda Place"
                    ],
                    "city": "Sunnyvale",
                    "state": "CA",
                    "postalCode": "94086",
                    "country": "USA"
                },
                "managingOrganization": {
                    "reference": "https://firely01dev.azurewebsites.net/Organization/74145ab0-b8b3-43a2-ace5-cd3cf480fe1c",
                    "display": "Sunnyvale Medical Oncology"
                },
                "meta": {
                    "versionId": "ba8b1b67-ac35-4574-adff-3a4f0f78cc07",
                    "lastUpdated": "2022-08-29T17:23:00.181+00:00"
                }
            }
        }
    ],
    "total": 3,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Location?_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "cdd4708a-5cf3-497c-b305-4a6271a66f19"
}
								  
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

MedicationRequest

readMedicationRequest

read: Read a FHIR MedicationRequest

/MedicationRequest/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /MedicationRequest/ec7a8489-3ad9-48f5-ad91-cca7c204b6b1

searchMedicationRequestGet

search-type: Search for MedicationRequest by Patient and Intent

/MedicationRequest?patient=[patient]&intent={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Returns prescriptions for a specific patient
Required
intent
String
Returns prescriptions with different intents
_include
String
Include additional resources, based on following links forward across references
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /MedicationRequest?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&intent=plan

search-type: Search for MedicationRequest by Patient, Intent and Status

/MedicationRequest?patient=[patient]&intent={system|}[code]&status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Returns prescriptions for a specific patient
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
intent
String
Returns prescriptions with different intents
_include
String
Include additional resources, based on following links forward across references
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /MedicationRequest?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&intent=plan&status=active

search-type: Search for MedicationRequest by Patient, Intent and Encounter

/MedicationRequest?patient=[patient]&intent={system|}[code]&encounter=[encounter]

Parameters

Query parameters
Name Description
patient*
String
Returns prescriptions for a specific patient
Required
intent
String
Returns prescriptions with different intents
encounter
String
Return prescriptions with this encounter identifier
_include
String
Include additional resources, based on following links forward across references
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /MedicationRequest?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&intent=plan&encounter=

search-type: Search for MedicationRequest by Patient, Intent and AuthoredOn Date

/MedicationRequest?patient=[patient]&intent={system|}[code]&authoredon={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Returns prescriptions for a specific patient
Required
intent
String
Returns prescriptions with different intents
authoredon
String
Return prescriptions written on this date
_include
String
Include additional resources, based on following links forward across references
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /MedicationRequest?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&intent=plan&authoredon=ge2001-01-01

Responses

Status: 200 - Success

								  
{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-22T00:06:46.259+00:00",
    "meta": {
        "lastUpdated": "2022-11-22T00:06:46.259+00:00",
        "versionId": "cdd0ba0e-aeed-4016-9ed8-bee84607443c"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/ec7a8489-3ad9-48f5-ad91-cca7c204b6b1",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "ec7a8489-3ad9-48f5-ad91-cca7c204b6b1",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-ec7a8489-3ad9-48f5-ad91-cca7c204b6b1",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "310351",
                                    "display": "Floxuridine 500 MG Injection"
                                }
                            ],
                            "text": "Floxuridine 500 MG Injection"
                        }
                    }
                ],
                "status": "completed",
                "intent": "plan",
                "reportedBoolean": false,
                "medicationReference": {
                    "reference": "#med-ec7a8489-3ad9-48f5-ad91-cca7c204b6b1"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2019-02-20T15:57:28.027-07:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "44 mg Injection once"
                    }
                ],
                "meta": {
                    "versionId": "3ffee81f-a881-4e52-87fe-5dd85582d497",
                    "lastUpdated": "2022-10-26T18:48:59.786+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/0c8c110a-e787-437c-98e0-5596f451b9b0",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "0c8c110a-e787-437c-98e0-5596f451b9b0",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-0c8c110a-e787-437c-98e0-5596f451b9b0",
                        "code": {
                            "coding": [
                                {
                                    "system": "https://www.fdbhealth.com/fdb-medknowledge",
                                    "code": "551058",
                                    "display": "Pediarix (PF)"
                                }
                            ],
                            "text": "Pediarix (PF)"
                        }
                    }
                ],
                "status": "active",
                "intent": "plan",
                "reportedBoolean": false,
                "medicationReference": {
                    "reference": "#med-0c8c110a-e787-437c-98e0-5596f451b9b0"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2017-04-11T11:49:20.433-06:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "0.5 mL Intramuscular route once"
                    }
                ],
                "meta": {
                    "versionId": "ddebe67c-7cb6-4323-86a8-d4e85b3a2053",
                    "lastUpdated": "2022-10-26T18:48:57.036+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/a041b9b5-7089-4613-810b-29472ef0a26d",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "a041b9b5-7089-4613-810b-29472ef0a26d",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-a041b9b5-7089-4613-810b-29472ef0a26d",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "106",
                                    "display": "diphtheria, tetanus toxoids and acellular pertussis vaccine, 5 pertussis antigens"
                                }
                            ],
                            "text": "diphtheria, tetanus toxoids and acellular pertussis vaccine, 5 pertussis antigens"
                        }
                    }
                ],
                "status": "completed",
                "intent": "plan",
                "reportedBoolean": false,
                "medicationReference": {
                    "reference": "#med-a041b9b5-7089-4613-810b-29472ef0a26d"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2016-09-27T15:56:14.047-06:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "0.5 mL Intramuscular route once"
                    }
                ],
                "meta": {
                    "versionId": "8e03a74e-a933-4cab-b9ad-ee785c0b5502",
                    "lastUpdated": "2022-10-26T18:48:52.311+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/2a6bed94-f317-4a3f-8e80-1b3a6ff9899c",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "2a6bed94-f317-4a3f-8e80-1b3a6ff9899c",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-2a6bed94-f317-4a3f-8e80-1b3a6ff9899c",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "88",
                                    "display": "Influenza, injectable, quadrivalent, preservative free"
                                }
                            ],
                            "text": "Influenza, injectable, quadrivalent, preservative free"
                        }
                    }
                ],
                "status": "completed",
                "intent": "plan",
                "reportedBoolean": false,
                "medicationReference": {
                    "reference": "#med-2a6bed94-f317-4a3f-8e80-1b3a6ff9899c"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2016-09-27T15:48:50.68-06:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "0.5 mL Intramuscular route once"
                    }
                ],
                "meta": {
                    "versionId": "82ffa689-9ceb-41e3-a4f2-e59fffc2c038",
                    "lastUpdated": "2022-10-26T18:48:49.775+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/b98c3971-2fef-43c3-91fa-1677b618ca86",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "b98c3971-2fef-43c3-91fa-1677b618ca86",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-b98c3971-2fef-43c3-91fa-1677b618ca86",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "731184",
                                    "display": "1 ML darbepoetin alfa 0.5 MG/ML Prefilled Syringe"
                                }
                            ],
                            "text": "1 ML darbepoetin alfa 0.5 MG/ML Prefilled Syringe"
                        }
                    }
                ],
                "status": "active",
                "intent": "plan",
                "reportedBoolean": false,
                "medicationReference": {
                    "reference": "#med-b98c3971-2fef-43c3-91fa-1677b618ca86"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2016-07-29T17:38:09.913-06:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "0.5 mL Injection once a week"
                    }
                ],
                "meta": {
                    "versionId": "862b0097-03a3-448d-960e-91b0ccb03036",
                    "lastUpdated": "2022-10-26T18:48:47.391+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/a7aa0cca-9f1f-42d6-a7da-4849e145865b",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "a7aa0cca-9f1f-42d6-a7da-4849e145865b",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-a7aa0cca-9f1f-42d6-a7da-4849e145865b",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "209459",
                                    "display": "Acetaminophen 500 MG Oral Tablet [Tylenol]"
                                }
                            ],
                            "text": "Acetaminophen 500 MG Oral Tablet [Tylenol]"
                        }
                    }
                ],
                "status": "active",
                "intent": "plan",
                "reportedBoolean": false,
                "medicationReference": {
                    "reference": "#med-a7aa0cca-9f1f-42d6-a7da-4849e145865b"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2016-07-29T17:31:30.933-06:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "1 Tablet Oral route As needed for 10 days PRN"
                    }
                ],
                "meta": {
                    "versionId": "32b2b0ad-9d02-4818-85bd-f126795acd02",
                    "lastUpdated": "2022-10-26T18:48:45.694+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/MedicationRequest/985ea25c-8264-45f4-bb63-c4c4bbfd740d",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "985ea25c-8264-45f4-bb63-c4c4bbfd740d",
                "contained": [
                    {
                        "resourceType": "Medication",
                        "id": "med-985ea25c-8264-45f4-bb63-c4c4bbfd740d",
                        "code": {
                            "coding": [
                                {
                                    "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                                    "code": "309090",
                                    "display": "Ceftriaxone Sodium"
                                }
                            ],
                            "text": "Ceftriaxone Sodium"
                        }
                    }
                ],
                "status": "stopped",
                "intent": "plan",
                "reportedBoolean": true,
                "medicationReference": {
                    "reference": "#med-985ea25c-8264-45f4-bb63-c4c4bbfd740d"
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "authoredOn": "2016-07-29T17:26:07.393-06:00",
                "requester": {
                    "reference": "https://firely01dev.azurewebsites.net/Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1",
                    "display": "Z, Z Z"
                },
                "dosageInstruction": [
                    {
                        "text": "100 mg Injection"
                    }
                ],
                "meta": {
                    "versionId": "5910c83c-c453-4c0d-afb3-5ea48b3dcfde",
                    "lastUpdated": "2022-10-26T18:48:43.981+00:00"
                }
            }
        }
    ],
    "total": 7,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/MedicationRequest?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "9577d43c-8fc4-4498-9ae2-295a436cffcb"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Observation

US Core Profiles

FHIR Core Profiles

readObservation

read: Read a FHIR Observation

/Observation/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Observation/8e2faf1d-578a-4d76-b46b-eacf0e6e9444

searchObservationGet

search-type: Search for Observation by Patient and Code

/Observation?patient=[patient]&code={system|}[code]

Parameters

Query parameters
String
Include additional resources, based on following reverse links across references
Name Description
patient*
String
The subject that the observation is about (if patient)
Required
code*
String
The code of the observation type
Required

Request

GET /Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&code=2708-6

search-type: Search for Observation by Patient and Category

/Observation?patient=[patient]&category={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
The subject that the observation is about (if patient)
Required
category*
String
Type of plan
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=vital-signs

search-type: Search for Observation by Patient, Category and Date

/Observation&category={system|}[code]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
The subject that the observation is about (if patient)
Required
category*
String
Type of plan
Required
date*
String
Obtained date/time. If the obtained element is a period, a date that falls in the period
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=vital-signs&date=ge2001-01-01

search-type: Search for Observation by Patient, Category and Status

/Observation?patient=[patient]&category={system|}[code]&status={system|}[code]

Parameters

Query parameters
Required
Name Description
patient*
String
The subject that the observation is about (if patient)
Required
category*
String
Type of plan
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&category=vital-signs&status=active

search-type: Search for Observation by Patient, Code and Date

/Observation?patient=[patient]&code={system|}[code]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
The subject that the observation is about (if patient)
Required
code*
String
The code of the observation type
Required
date*
String
Obtained date/time. If the obtained element is a period, a date that falls in the period
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&code=2708-6&date=ge2001-01-01

Responses

Status: 200 - Success

								  
{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T23:57:33.022+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T23:57:33.022+00:00",
        "versionId": "0936344f-1bea-4f90-9684-484ca8c6ee15"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/8e2faf1d-578a-4d76-b46b-eacf0e6e9444",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "8e2faf1d-578a-4d76-b46b-eacf0e6e9444",
                "status": "preliminary",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "vital-signs",
                                "display": "Vital Signs"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "2708-6",
                            "display": "Oxygen saturation in Arterial blood"
                        },
                        {
                            "system": "http://loinc.org",
                            "code": "59408-5",
                            "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2022-09-02T08:42:39-06:00",
                "valueQuantity": {
                    "value": 98,
                    "unit": "percent",
                    "system": "http://unitsofmeasure.org",
                    "code": "%"
                },
                "component": [
                    {
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "3150-0",
                                    "display": "Inhaled oxygen concentration"
                                }
                            ]
                        },
                        "valueQuantity": {
                            "value": 90,
                            "unit": "percent",
                            "system": "http://unitsofmeasure.org",
                            "code": "%"
                        }
                    },
                    {
                        "code": {
                            "coding": [
                                {
                                    "system": "http://loinc.org",
                                    "code": "3151-8",
                                    "display": "Inhaled oxygen flow rate"
                                }
                            ]
                        },
                        "valueQuantity": {
                            "value": 9,
                            "unit": "liter per minute",
                            "system": "http://unitsofmeasure.org",
                            "code": "L/min"
                        }
                    }
                ],
                "meta": {
                    "versionId": "bc005819-c5cd-4644-b077-51ab66f416ca",
                    "lastUpdated": "2022-10-26T18:50:06.764+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/41e513fd-05d8-4276-a539-ca8d9bd724bc",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "41e513fd-05d8-4276-a539-ca8d9bd724bc",
                "status": "preliminary",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "vital-signs",
                                "display": "Vital Signs"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "77606-2",
                            "display": "Weight-for-length Per age and sex"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2022-09-02T08:42:39-06:00",
                "valueQuantity": {
                    "value": 78,
                    "unit": "percent",
                    "system": "http://unitsofmeasure.org",
                    "code": "%"
                },
                "meta": {
                    "versionId": "b32b212b-df95-4904-b68d-e955e5f06bac",
                    "lastUpdated": "2022-10-26T18:50:05.878+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/566322dd-792d-4ac3-a792-dcf045eb1818",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "566322dd-792d-4ac3-a792-dcf045eb1818",
                "status": "preliminary",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "vital-signs",
                                "display": "Vital Signs"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "8289-1",
                            "display": "Head Occipital-frontal circumference Percentile"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2022-09-02T08:42:39-06:00",
                "valueQuantity": {
                    "value": 30,
                    "unit": "percent",
                    "system": "http://unitsofmeasure.org",
                    "code": "%"
                },
                "meta": {
                    "versionId": "2a81b198-a01f-44f3-a4a9-efb223c0b71f",
                    "lastUpdated": "2022-10-26T18:50:04.103+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/e38406ac-903c-4864-807c-6295783f3c78",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "e38406ac-903c-4864-807c-6295783f3c78",
                "status": "preliminary",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "vital-signs",
                                "display": "Vital Signs"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "59576-9",
                            "display": "Body mass index (BMI) [Percentile] Per age and sex"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2022-09-02T08:42:39-06:00",
                "valueQuantity": {
                    "value": 67,
                    "unit": "percent",
                    "system": "http://unitsofmeasure.org",
                    "code": "%"
                },
                "meta": {
                    "versionId": "ac32faed-6741-4522-a805-39df3fa5429b",
                    "lastUpdated": "2022-10-26T18:49:58.351+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/9282e303-4ccf-4d10-82ed-a4d856e95a98",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "9282e303-4ccf-4d10-82ed-a4d856e95a98",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "social-history",
                                "display": "Social History"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "72166-2",
                            "display": "Tobacco smoking status"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "issued": "2015-06-22T08:12:00-06:00",
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "449868002",
                            "display": "Current everyday smoker"
                        }
                    ],
                    "text": "Current everyday smoker"
                },
                "meta": {
                    "versionId": "9d7b4875-0e0d-4841-9bad-3494ba7350ad",
                    "lastUpdated": "2022-10-26T18:49:45.122+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/715f9118-8c3f-41bb-8f6c-235f6c2cf78d",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "715f9118-8c3f-41bb-8f6c-235f6c2cf78d",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "laboratory",
                                "display": "Laboratory"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "5778-6",
                            "display": "Color of Urine"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2015-06-22T08:34:34-06:00",
                "valueString": "YELLOW",
                "referenceRange": [
                    {
                        "text": "YELLOW"
                    }
                ],
                "meta": {
                    "versionId": "bcb2cf50-80c2-4d6c-b428-0c6d7ed94b01",
                    "lastUpdated": "2022-10-26T18:49:36.937+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/54d80399-788b-42f7-a434-1938770b3c45",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "54d80399-788b-42f7-a434-1938770b3c45",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "laboratory",
                                "display": "Laboratory"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "5767-9",
                            "display": "Appearance of Urine"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2015-06-22T08:34:34-06:00",
                "valueString": "CLEAR",
                "referenceRange": [
                    {
                        "text": "CLEAR"
                    }
                ],
                "meta": {
                    "versionId": "e364bfe1-4cf1-446b-ab05-94da66a35699",
                    "lastUpdated": "2022-10-26T18:49:35.219+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/1fb9dd7c-4495-4dc8-a36a-00747a5b6d39",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "1fb9dd7c-4495-4dc8-a36a-00747a5b6d39",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "laboratory",
                                "display": "Laboratory"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "5811-5",
                            "display": "Specific gravity of Urine by Test strip"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2015-06-22T08:34:34-06:00",
                "valueString": "1.015",
                "referenceRange": [
                    {
                        "text": "5.0-8.0"
                    }
                ],
                "meta": {
                    "versionId": "3b710307-310b-47f3-9594-45926e18113f",
                    "lastUpdated": "2022-10-26T18:49:33.611+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/79c4c685-9b00-480c-b467-12a2bd5674b7",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "79c4c685-9b00-480c-b467-12a2bd5674b7",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "laboratory",
                                "display": "Laboratory"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "5803-2",
                            "display": "pH of Urine by test strip"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2015-06-22T08:34:34-06:00",
                "valueString": "5.0 pH",
                "referenceRange": [
                    {
                        "text": "5.0-8.0"
                    }
                ],
                "meta": {
                    "versionId": "6945c461-59af-4d66-bb5b-2caa54b64bfa",
                    "lastUpdated": "2022-10-26T18:49:31.985+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Observation/eb66b77c-41b7-4f36-a002-73ce35d0e3bd",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Observation",
                "id": "eb66b77c-41b7-4f36-a002-73ce35d0e3bd",
                "status": "final",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                                "code": "laboratory",
                                "display": "Laboratory"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "http://loinc.org",
                            "code": "5792-7",
                            "display": "Glucose in urine by test strip"
                        }
                    ]
                },
                "subject": {
                    "reference": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "effectiveDateTime": "2015-06-22T08:34:34-06:00",
                "valueString": "50 mg/dL",
                "referenceRange": [
                    {
                        "text": "Neg"
                    }
                ],
                "meta": {
                    "versionId": "37c75d2d-621a-4c64-b8de-cd2cdcc019d0",
                    "lastUpdated": "2022-10-26T18:49:30.351+00:00"
                }
            }
        }
    ],
    "total": 24,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0"
        },
        {
            "relation": "next",
            "url": "https://firely01dev.azurewebsites.net/Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=10"
        },
        {
            "relation": "last",
            "url": "https://firely01dev.azurewebsites.net/Observation?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=20"
        }
    ],
    "id": "824551aa-bab2-48eb-8ed1-9b88bd8d4854"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Organization

readOrganization

read: Read a FHIR Organization

/Organization/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Organization/5c4a9fbf-28bb-4d8f-b5b0-6448857e2e17

searchOrganizationGet

search-type: Search for Organization by Name

/Organization?name=[string]

Parameters

Query parameters
Name Description
name*
String
A portion of the location's name or alias
Required

Request

GET /Organization?name=Sunnyvale Radiation Oncology

search-type: Search for Organization by Address

/Organization?address=[string]

Parameters

Query parameters
Name Description
address*
String
A (part of the) address of the location
Required

Request

GET /Organization?address=100 Mathilda Place

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-23T18:31:38.840+00:00",
    "meta": {
        "lastUpdated": "2022-11-23T18:31:38.840+00:00",
        "versionId": "a40b3ab1-351c-4989-804e-28cf299d0070"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Organization/5c4a9fbf-28bb-4d8f-b5b0-6448857e2e17",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Organization",
                "id": "5c4a9fbf-28bb-4d8f-b5b0-6448857e2e17",
                "identifier": [
                    {
                        "type": {
                            "text": "NPI"
                        },
                        "system": "http://hl7.org/fhir/sid/us-npi",
                        "value": "999999999"
                    }
                ],
                "active": true,
                "name": "Sunnyvale Radiation Oncology",
                "telecom": [
                    {
                        "system": "phone",
                        "value": "800-488-4672"
                    },
                    {
                        "system": "email",
                        "value": "test@email.com"
                    }
                ],
                "address": [
                    {
                        "line": [
                            "100 Mathilda Place"
                        ],
                        "city": "Sunnyvale",
                        "state": "CA",
                        "postalCode": "94086",
                        "country": "USA"
                    }
                ],
                "meta": {
                    "versionId": "7a1973a9-580c-428d-b212-ec580a71a3e7",
                    "lastUpdated": "2022-10-26T18:48:16.082+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Organization/7d3ec622-4b8a-47df-866b-99e408114bfb",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Organization",
                "id": "7d3ec622-4b8a-47df-866b-99e408114bfb",
                "identifier": [
                    {
                        "type": {
                            "text": "NPI"
                        },
                        "system": "http://hl7.org/fhir/sid/us-npi",
                        "value": "999999999"
                    }
                ],
                "active": true,
                "name": "Sunnyvale Radiation Oncology",
                "telecom": [
                    {
                        "system": "phone",
                        "value": "800-488-4672"
                    },
                    {
                        "system": "email",
                        "value": ""test@email.com "
                    }
                ],
                "address": [
                    {
                        "line": [
                            "100 Mathilda Place"
                        ],
                        "city": "Sunnyvale",
                        "state": "CA",
                        "postalCode": "94086",
                        "country": "USA"
                    }
                ],
                "meta": {
                    "versionId": "2e03af9c-6fc3-4fd1-8cf1-297da56838fa",
                    "lastUpdated": "2022-08-29T17:22:55.447+00:00"
                }
            }
        }
    ],
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Organization?name=sunnyvale%20radiation%20oncology&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "84659919-f08e-4583-8b2b-6f5bf66e8b47"
}
								  
								  

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Patient

readPatient

read: Read a FHIR Patient

/Patient/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff

searchPatientGet

search-type: Search for Patient by Id

/Patient?_id=[id]

Parameters

Query parameters
Name Description
_id*
String
Logical id of this artifact
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?_id=Portal-567

search-type: Search for Patient by Identifier

/Patient?identifier={system|}[code]

Parameters

Query parameters
Name Description
identifier*
String
Identifier for the patient
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?identifier=IDA

search-type: Search for Patient by Name

/Patient?name=[string]

Parameters

Query parameters
Name Description
name*
String
A portion of the location's name or alias
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?name=Alice

search-type: Search for Patient by BirthDate and Name

/Patient?birthdate=[date]&name=[string]

Parameters

Query parameters
Name Description
birthdate*
String
The patient's date of birth
Required
name*
String
A portion of the location's name or alias
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?birthdate=1990-02-01&name=Alice

search-type: Search for Patient by Gender and Name

/Patient?gender={system|}[code]&name=[string]

Parameters

Query parameters
Name Description
gender*
String
Gender of the patient
Required
name*
String
A portion of the location's name or alias
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?gender=female&name=Alice

search-type: Search for Patient by BirthDate and FamilyName

/Patient?birthdate=[date]&family=[string]

Parameters

Query parameters
Name Description
birthdate*
String
The patient's date of birth
Required
family*
String
Family name or alias
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?birthdate=1970-05-01&family=Newman

search-type: Search for Patient by FamilyName and Gender

/Patient?family=[string]&gender={system|}[code]

Parameters

Query parameters
Name Description
family*
String
Family name or alias
Required
gender*
String
Gender of the patient
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Patient?family=Newman&gender=female

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-21T18:52:20.340+00:00",
    "meta": {
        "lastUpdated": "2022-11-21T18:52:20.340+00:00",
        "versionId": "24da7ab6-530b-49a4-b370-e3e5c014aa0c"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Patient/4E46A943-E4DC-4FEE-BE32-D236A67091A7",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Patient",
                "id": "4E46A943-E4DC-4FEE-BE32-D236A67091A7",
                "identifier": [
                    {
                        "type": {
                            "text": "IDA"
                        },
                        "system": "https://www.elekta.com/ids/ida",
                        "value": "Portal-567"
                    }
                ],
                "active": true,
                "name": [
                    {
                        "family": "Newman",
                        "given": [
                            "Alice"
                        ]
                    }
                ],
                "gender": "Female",
                "birthDate": "1970-05-01",
                "meta": {
                    "versionId": "162818f1-9856-4cbd-81e8-e84fd4a07a32",
                    "lastUpdated": "2022-11-03T19:42:42.006+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Patient",
                "id": "48235650-e0bf-43f6-a790-f322b3b0f8ff",
                "extension": [
                    {
                        "extension": [
                            {
                                "url": "detailed",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2108-9",
                                    "display": "European"
                                }
                            },
                            {
                                "url": "text",
                                "valueString": "European"
                            }
                        ],
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
                    },
                    {
                        "extension": [
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2186-5",
                                    "display": "Not Hispanic or Latino"
                                }
                            },
                            {
                                "url": "text",
                                "valueString": "Not Hispanic or Latino"
                            }
                        ],
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
                    },
                    {
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                        "valueCode": "UNK"
                    }
                ],
                "identifier": [
                    {
                        "type": {
                            "text": "IDA"
                        },
                        "system": "https://www.elekta.com/ids/ida",
                        "value": "Portal-567"
                    }
                ],
                "active": true,
                "name": [
                    {
                        "family": "Newman",
                        "given": [
                            "Alice",
                            "Jones"
                        ],
                        "period": {
                            "start": "1970-05-01T00:00:00-06:00"
                        }
                    }
                ],
                "telecom": [
                    {
                        "system": "phone",
                        "value": "555-723-1544",
                        "use": "home"
                    },
                    {
                        "system": "phone",
                        "value": "555-777-1234",
                        "use": "mobile"
                    },
                    {
                        "system": "email",
                        "value": "randy.norton@elekta.com",
                        "use": "home"
                    }
                ],
                "gender": "female",
                "birthDate": "1970-05-01",
                "address": [
                    {
                        "line": [
                            "1357 Amber Dr"
                        ],
                        "city": "Beaverton",
                        "state": "OR",
                        "postalCode": "97006",
                        "period": {
                            "start": "1970-05-01T00:00:00-06:00"
                        }
                    }
                ],
                "communication": [
                    {
                        "language": {
                            "coding": [
                                {
                                    "system": "urn:ietf:bcp:47",
                                    "display": "English"
                                }
                            ],
                            "text": "English"
                        }
                    }
                ],
                "meta": {
                    "versionId": "0c2b6dcd-f038-4842-926b-4da36739a8fb",
                    "lastUpdated": "2022-10-26T18:48:31.493+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Patient/548310d3-ec8b-4020-ac96-9c151be97560",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Patient",
                "id": "548310d3-ec8b-4020-ac96-9c151be97560",
                "extension": [
                    {
                        "extension": [
                            {
                                "url": "detailed",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2108-9",
                                    "display": "European"
                                }
                            },
                            {
                                "url": "text",
                                "valueString": "European"
                            }
                        ],
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
                    },
                    {
                        "extension": [
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2186-5",
                                    "display": "Not Hispanic or Latino"
                                }
                            },
                            {
                                "url": "text",
                                "valueString": "Not Hispanic or Latino"
                            }
                        ],
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
                    },
                    {
                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
                        "valueCode": "UNK"
                    }
                ],
                "identifier": [
                    {
                        "type": {
                            "text": "IDA"
                        },
                        "system": "https://elekta.com/ida",
                        "value": "Portal-567"
                    }
                ],
                "active": true,
                "name": [
                    {
                        "family": "Newman",
                        "given": [
                            "Alice",
                            "Jones"
                        ],
                        "period": {
                            "start": "1970-05-01T00:00:00-06:00"
                        }
                    }
                ],
                "telecom": [
                    {
                        "system": "phone",
                        "value": "555-723-1544",
                        "use": "home"
                    },
                    {
                        "system": "phone",
                        "value": "555-777-1234",
                        "use": "mobile"
                    },
                    {
                        "system": "email",
                        "value": "randy.norton@elekta.com",
                        "use": "home"
                    }
                ],
                "gender": "female",
                "birthDate": "1970-05-01",
                "address": [
                    {
                        "line": [
                            "1357 Amber Dr"
                        ],
                        "city": "Beaverton",
                        "state": "OR",
                        "postalCode": "97006",
                        "period": {
                            "start": "1970-05-01T00:00:00-06:00"
                        }
                    }
                ],
                "communication": [
                    {
                        "language": {
                            "coding": [
                                {
                                    "system": "urn:ietf:bcp:47",
                                    "display": "English"
                                }
                            ],
                            "text": "English"
                        }
                    }
                ],
                "meta": {
                    "versionId": "2b579d3a-3700-401a-bd5e-914f5d4e1a81",
                    "lastUpdated": "2022-08-29T17:23:52.717+00:00"
                }
            }
        }
    ],
    "total": 3,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Patient?family=newman&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "d61eafd7-3b68-4518-8f98-43788ae0bc83"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Practitioner

readPractitioner

read: Read a FHIR Practitioner

/Practitioner/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Practitioner/a938058a-481b-45d4-9c6a-51b9cecf40a1

searchPractitionerGet

search-type: Search for Practitioner by Name

/Practitioner?name=[string]

Parameters

Query parameters
Name Description
name*
String
A portion of the location's name or alias
Required

Request

GET /Practitioner?name=Albert

search-type: Search for Practitioner by Identifier

/Practitioner?identifier={system|}[code]

Parameters

Query parameters
Name Description
identifier*
String
Unique identifier of the practitioner
Required

Request

GET /Practitioner?identifier=405279007

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-23T18:36:15.408+00:00",
    "meta": {
        "lastUpdated": "2022-11-23T18:36:15.408+00:00",
        "versionId": "f2b195da-4de4-4bad-9706-c2348d81545d"
    },
    "entry": [
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Practitioner/90f56f20-e7b4-407a-b0a3-2e5ff2c76445",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Practitioner",
                "id": "90f56f20-e7b4-407a-b0a3-2e5ff2c76445",
                "identifier": [
                    {
                        "extension": [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                "valueCode": "unknown"
                            }
                        ]
                    }
                ],
                "active": true,
                "name": [
                    {
                        "family": "Davis",
                        "given": [
                            "Tracy"
                        ]
                    }
                ],
                "telecom": [
                    {
                        "system": "phone",
                        "value": "555-555-1002"
                    }
                ],
                "meta": {
                    "versionId": "21414b8c-dd01-4568-8272-26cfbe3eb86f",
                    "lastUpdated": "2022-10-26T18:48:00.272+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01dev.azurewebsites.net/Practitioner/4d9e45b5-1dc4-44c5-8eb4-1b8469dd7b5e",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Practitioner",
                "id": "4d9e45b5-1dc4-44c5-8eb4-1b8469dd7b5e",
                "identifier": [
                    {
                        "extension": [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                "valueCode": "unknown"
                            }
                        ]
                    }
                ],
                "active": true,
                "name": [
                    {
                        "family": "Davis",
                        "given": [
                            "Tracy"
                        ]
                    }
                ],
                "telecom": [
                    {
                        "system": "phone",
                        "value": "555-555-1002"
                    }
                ],
                "meta": {
                    "versionId": "f8f355a2-af99-4fa0-abef-e9ff5a7185a7",
                    "lastUpdated": "2022-08-29T17:22:59.049+00:00"
                }
            }
        }
    ],
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01dev.azurewebsites.net/Practitioner?name=tracy&_total=accurate&_count=10&_skip=0"
        }
    ],
    "id": "7bca7eee-c6ec-4a82-b96b-00db81d97e94"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found

Procedure

readProcedure

read: Read a FHIR Procedure

/Procedure/{logical_id}

Parameters

Path parameters
Name Description
logical_id*
String
Resource Logical ID
Required

Request

GET /Procedure/5cfe2985-7ec4-471e-ad95-a92a719010e2

searchProcedureGet

search-type: Search for Procedure by Patient

/Procedure?patient=[patient]

Parameters

Query parameters
Name Description
patient*
String
Search by subject - a patient
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Procedure?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff

search-type: Search for Procedure by Patient and Date

/Procedure?patient=[patient]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Search by subject - a patient
Required
date*
String
When the procedure was performed
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Procedure?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&date=ge2001-01-01

search-type: Search for Procedure by Patient and Status

/Procedure?patient=[patient]&status={system|}[code]

Parameters

Query parameters
Name Description
patient*
String
Search by subject - a patient
Required
status*
String
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Procedure?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&status=active

search-type: Search for Procedure by Patient, Code and Date

/Procedure?patient=[patient]&code={system|}[code]&date={gt|lt|ge|le}[date]

Parameters

Query parameters
Name Description
patient*
String
Search by subject - a patient
Required
code*
String
A code to identify a procedure
Required
date*
String
When the procedure was performed
Required
_revinclude
String
Include additional resources, based on following reverse links across references

Request

GET /Procedure?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&code=56251003&date=ge2001-01-01

Responses

Status: 200 - Success


{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "2022-11-23T18:52:23.182+00:00",
    "meta": {
        "lastUpdated": "2022-11-23T18:52:23.182+00:00",
        "versionId": "62f4b77a-3cae-4ae6-aa71-34406da5c535"
    },
    "entry": [
        {
            "fullUrl": "https://firely01elektacert.azurewebsites.net/Procedure/5cfe2985-7ec4-471e-ad95-a92a719010e2",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "Procedure",
                "id": "5cfe2985-7ec4-471e-ad95-a92a719010e2",
                "status": "completed",
                "code": {
                    "coding": [
                        {
                            "system": "http://www.ama-assn.org/go/cpt",
                            "code": "56251003",
                            "display": "Nebulizer Therapy"
                        }
                    ],
                    "text": "Nebulizer Therapy"
                },
                "subject": {
                    "reference": "https://firely01elektacert.azurewebsites.net/Patient/48235650-e0bf-43f6-a790-f322b3b0f8ff",
                    "display": "Newman, Alice Jones"
                },
                "performedDateTime": "2015-06-22T08:30:00+00:00",
                "performer": [
                    {
                        "actor": {
                            "reference": "https://firely01elektacert.azurewebsites.net/Practitioner/a320ba5e-265c-4a69-bfff-af0aea645bab",
                            "display": "Davis, Albert"
                        }
                    }
                ],
                "meta": {
                    "versionId": "b8d08fdf-0a84-4af3-a39b-d28d8f8afe3e",
                    "lastUpdated": "2022-11-18T23:05:36.345+00:00"
                }
            }
        },
        {
            "fullUrl": "https://firely01elektacert.azurewebsites.net/Provenance/PROV-5cfe2985-7ec4-471e-ad95-a92a719010e2",
            "search": {
                "mode": "include"
            },
            "resource": {
                "resourceType": "Provenance",
                "id": "PROV-5cfe2985-7ec4-471e-ad95-a92a719010e2",
                "target": [
                    {
                        "reference": "https://firely01elektacert.azurewebsites.net/Procedure/5cfe2985-7ec4-471e-ad95-a92a719010e2"
                    }
                ],
                "recorded": "2022-11-18T23:02:02.453+00:00",
                "agent": [
                    {
                        "type": {
                            "coding": [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                    "code": "author",
                                    "display": "Author"
                                }
                            ]
                        },
                        "who": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ],
                            "display": "Unknown"
                        },
                        "onBehalfOf": {
                            "reference": "https://firely01elektacert.azurewebsites.net/Organization/5c4a9fbf-28bb-4d8f-b5b0-6448857e2e17"
                        }
                    },
                    {
                        "type": {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
                                    "code": "transmitter",
                                    "display": "Transmitter"
                                }
                            ]
                        },
                        "who": {
                            "extension": [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                                    "valueCode": "unknown"
                                }
                            ],
                            "display": "Unknown"
                        }
                    }
                ],
                "meta": {
                    "versionId": "358d5d06-83b9-48cf-be99-c0090d550ea9",
                    "lastUpdated": "2022-11-18T23:05:36.522+00:00"
                }
            }
        }
    ],
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://firely01elektacert.azurewebsites.net/Procedure?patient=48235650-e0bf-43f6-a790-f322b3b0f8ff&_total=accurate&_count=10&_skip=0&_revinclude=Provenance:target"
        }
    ],
    "id": "b73f9663-8f77-4369-af3a-5168ec7442bf"
}

Status: 401 - Resource not authorized to be viewed by this user

Status: 400 - Resource not found