Patients

To define

Supported Formats

json
>>>

GET /Patients
Patient Bundle

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Patient?_id=1&access_token=6Eu5NRQ3GoJJ7APcJXKaWsFK9Xg1XWd1LRYh9tBxpJdCQw1nUB3QUHLnTZPfdVov
200
{
  "resourceType": "Bundle",
  "id": "7b07139243eb508b88f1c523e5a85880",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Patient/1",
      "resource": {
        "resourceType": "Patient",
        "id": "1",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": null,
                  "code": "en-US"
                }
              ],
              "text": "English"
            }
          }
        ],
        "identifier": [
          {
            "system": null,
            "value": "1"
          }
        ],
        "gender": "female",
        "maritalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
              "code": "UNK"
            }
          ]
        },
        "address": [
          {
            "line": [
              "1357, Amber Drive,"
            ],
            "postalCode": "97006",
            "city": "Beaverton",
            "state": "OR",
            "country": "US",
            "period": {
              "start": "2012-12-13"
            }
          }
        ],
        "birthDate": "1970-05-01",
        "name": [
          {
            "family": "Newman",
            "given": [
              "Alice",
              "Jones",
              "Alicia"
            ],
            "suffix": []
          },
          {
            "use": "old",
            "family": null,
            "given": [],
            "period": {
              "end": null
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "555-723-1544",
            "use": "home"
          },
          {
            "system": "phone",
            "value": "555-777-1234",
            "use": "mobile"
          },
          {
            "system": "email",
            "value": "anewman@carepaths.com",
            "use": "home"
          }
        ],
        "extension": [
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                  "code": "ASKU",
                  "display": "asked but unknown"
                }
              ],
              "text": "asked but unknown"
            }
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode": "F"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
            "extension": [
              {
                "url": "text",
                "valueString": "White"
              }
            ]
          },
          {
            "extension": [
              {
                "url": "text",
                "valueString": "Not Hispanic or Latino"
              }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
          }
        ]
      }
    }
  ],
  "total": 1
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

ID of the requested patient

Validations:

  • Must be number.
name
optional

name of the requested patient

Validations:

  • Must be string.
gender
optional

Gender of the requested patient

Validations:

  • Must be string.
birthdate
optional

Patient birthdate; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Bundle

Validations:

  • Must be String.
type
required

Validations:

  • Must be String.
>>>

GET /Patients/:id
Patients

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Patient/1?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Patient",
  "id": "1",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
    ]
  },
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": null,
            "code": "en-US"
          }
        ],
        "text": "English"
      }
    }
  ],
  "identifier": [
    {
      "system": null,
      "value": "1"
    }
  ],
  "gender": "female",
  "maritalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
        "code": "UNK"
      }
    ]
  },
  "address": [
    {
      "line": [
        "1357, Amber Drive,"
      ],
      "postalCode": "97006",
      "city": "Beaverton",
      "state": "OR",
      "country": "US",
      "period": {
        "start": "2012-12-13"
      }
    }
  ],
  "birthDate": "1970-05-01",
  "name": [
    {
      "family": "Newman",
      "given": [
        "Alice",
        "Jones",
        "Alicia"
      ],
      "suffix": []
    },
    {
      "use": "old",
      "family": null,
      "given": [],
      "period": {
        "end": null
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "555-723-1544",
      "use": "home"
    },
    {
      "system": "phone",
      "value": "555-777-1234",
      "use": "mobile"
    },
    {
      "system": "email",
      "value": "anewman@carepaths.com",
      "use": "home"
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
            "code": "ASKU",
            "display": "asked but unknown"
          }
        ],
        "text": "asked but unknown"
      }
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
      "valueCode": "F"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
      "extension": [
        {
          "url": "text",
          "valueString": "White"
        }
      ]
    },
    {
      "extension": [
        {
          "url": "text",
          "valueString": "Not Hispanic or Latino"
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
    }
  ]
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.
id
optional

ID of requested patient

Validations:

  • Must be number.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Patient

Validations:

  • Must be String.
communication
required

Validations:

  • Must be Communication.
identifier
required

Validations:

  • Must be Array.
gender
required

Validations:

  • Must be String.
marital_status
required

Validations:

  • Must be Hash.
address
required

Validations:

  • Must be Address.
birth_date
required

Validations:

  • Must be String.
name
required

Validations:

  • Must be PatientName.
telecom
required

Validations:

  • Must be ContactInfo.
extension
required

Validations:

  • Must be PatientExtension.
>>>

GET /Patients/_search
Patient search

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

ID of the requested patient

Validations:

  • Must be number.
name
optional

name of the requested patient

Validations:

  • Must be string.
gender
optional

Gender of the requested patient

Validations:

  • Must be string.
birthdate
optional

Patient birthdate; Format YYYY-MM-DD

Validations:

  • Must be Date.