POST /api/Patient/_search
Patient Search by POST

GET /api/Patient/:id
Patient Information by ID

Supported Formats

json

Errors

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

Examples

GET /Patient/1
401
GET /Patient/1?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    },
    {
      "line": [
        "No Known Value"
      ],
      "postalCode": "No Known Value",
      "city": "No Known Value",
      "state": "No Known Value",
      "country": "US",
      "period": {
        "start": "2016-02-27"
      },
      "use": "old"
    }
  ],
  "birthDate": "1970-05-01",
  "deceasedBoolean": false,
  "name": [
    {
      "family": "Newman",
      "given": [
        "Alice",
        "Jones",
        "Alicia"
      ],
      "suffix": [
        "No known value"
      ]
    },
    {
      "use": "old",
      "family": "No known value",
      "given": [
        "No known value"
      ],
      "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"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
      "extension": [
        {
          "url": "text",
          "valueString": "Not Hispanic or Latino"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248152002"
    },
    {
      "extension": [
        {
          "url": "isEnrolled",
          "valueBoolean": false
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
    }
  ]
}
GET /Patient/1?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    },
    {
      "line": [
        "No Known Value"
      ],
      "postalCode": "No Known Value",
      "city": "No Known Value",
      "state": "No Known Value",
      "country": "US",
      "period": {
        "start": "2016-02-27"
      },
      "use": "old"
    }
  ],
  "birthDate": "1970-05-01",
  "deceasedBoolean": false,
  "name": [
    {
      "family": "Newman",
      "given": [
        "Alice",
        "Jones",
        "Alicia"
      ],
      "suffix": [
        "No known value"
      ]
    },
    {
      "use": "old",
      "family": "No known value",
      "given": [
        "No known value"
      ],
      "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"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
      "extension": [
        {
          "url": "text",
          "valueString": "Not Hispanic or Latino"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248152002"
    },
    {
      "extension": [
        {
          "url": "isEnrolled",
          "valueBoolean": false
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
    }
  ]
}
GET /Patient/1?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    },
    {
      "line": [
        "No Known Value"
      ],
      "postalCode": "No Known Value",
      "city": "No Known Value",
      "state": "No Known Value",
      "country": "US",
      "period": {
        "start": "2016-02-27"
      },
      "use": "old"
    }
  ],
  "birthDate": "1970-05-01",
  "deceasedBoolean": false,
  "name": [
    {
      "family": "Newman",
      "given": [
        "Alice",
        "Jones",
        "Alicia"
      ],
      "suffix": [
        "No known value"
      ]
    },
    {
      "use": "old",
      "family": "No known value",
      "given": [
        "No known value"
      ],
      "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"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
      "extension": [
        {
          "url": "text",
          "valueString": "Not Hispanic or Latino"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248152002"
    },
    {
      "extension": [
        {
          "url": "isEnrolled",
          "valueBoolean": false
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
    }
  ]
}
GET /Patient/1?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    },
    {
      "line": [
        "No Known Value"
      ],
      "postalCode": "No Known Value",
      "city": "No Known Value",
      "state": "No Known Value",
      "country": "US",
      "period": {
        "start": "2016-02-27"
      },
      "use": "old"
    }
  ],
  "birthDate": "1970-05-01",
  "deceasedBoolean": false,
  "name": [
    {
      "family": "Newman",
      "given": [
        "Alice",
        "Jones",
        "Alicia"
      ],
      "suffix": [
        "No known value"
      ]
    },
    {
      "use": "old",
      "family": "No known value",
      "given": [
        "No known value"
      ],
      "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"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
      "extension": [
        {
          "url": "text",
          "valueString": "Not Hispanic or Latino"
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248152002"
    },
    {
      "extension": [
        {
          "url": "isEnrolled",
          "valueBoolean": false
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
    }
  ]
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
_id
optional

ID of requested patient

Validations:

  • Must be number.
identifier
optional

ID of requested patient

Validations:

  • Must be number.
name
optional

Last name of Patient

Validations:

  • Must be string.
birthdate
optional

Patient birth date + Name

Validations:

  • Must be date.
gender
optional

Patient Gender + Name

Validations:

  • Must be string.

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.
deceased
required

Validations:

  • Must be String.
name
required

Validations:

  • Must be PatientName.
telecom
required

Validations:

  • Must be ContactInfo.
extension
required

Validations:

  • Must be PatientExtension.