Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB
FHIR

Read a specified FHIR resource.

This endpoint is not included by default. If you require access, please contact support@particlehealth.com.

get/R4/{resource_type}/{resource_id}

Path parameters

resource_typestring required

Resource Type

resource_idstring required

Resource ID

Response

OK

birthDatestring required

The patient's date of birth, must be of the format YYYY-MM-DD.

genderstring required

The patient's gender, must be either FEMALE or MALE.

idstring

The patient's FHIR resource ID. This field will be ignored if provided in create requests and an ID will be provided in the response.

resourceTypestring required

The type of resource being provided.

Example response

{
  "address": [
    {
      "city": "Brooklyn",
      "line": [
        "999 Dev Drive"
      ],
      "postalCode": "11111",
      "state": "New York"
    }
  ],
  "birthDate": "01-23-1900",
  "gender": "FEMALE",
  "id": "d80538f5-203a-4a1e-9b41-2919e174f19b",
  "identifier": [
    {
      "type": {
        "text": "SSN"
      },
      "value": "123-45-6789"
    }
  ],
  "name": [
    {
      "family": "Quark",
      "given": [
        "Kam"
      ]
    }
  ],
  "resourceType": "Patient",
  "telecom": [
    {
      "system": "PHONE",
      "value": "123-456-7890"
    }
  ]
}