Patient

Profiles we support

Base structure definition

API Endpoints

READ

The [patient|user|system]/Patient.read scope is required.


  GET /fhir/Patient/{id}
Parameter Type Description
id string Required. The logical id of the resource

Response Codes

Code Description
200 OK The requested Patient resource within the body of the HTTP response.
400 Bad Request The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description
404 Not Found The requested resource does not exist.
500 Internal Server Error An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description

GET Search

The [patient|user|system]/Patient.read scope is required.

Patient search requests conditionally require one of the following search parameters or combinations in order return a result:


GET /fhir/Patient
Parameter Type Description
_id token Conditional Required. Patient.id resource reference to FHIR Patient resource.
identifier token Conditional Required. A patient identifier.
name string Conditional Required. A server defined search that may match any of the string fields in the HumanName
birthdate date Conditional Required. Patient's date of birth
gender token Conditional Required. Patient's Gender.
_revinclude string Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Supported values: Provenance:target

Response Codes

Code Description
200 OK The body of the response will contain a Bundle resource.
400 Bad Request The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description
404 Not Found The requested resource does not exist.
500 Internal Server Error An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description

POST Search

The [patient|user|system]/Patient.read scope is required.

Patient search requests conditionally require one of the following search parameters or combinations in order return a result:


          POST /fhir/Patient/_search
Parameter Type Description
_id token Conditional Required. Patient.id resource reference to FHIR Patient resource.
identifier token Conditional Required. A patient identifier.
name string Conditional Required. A server defined search that may match any of the string fields in the HumanName
birthdate date Conditional Required. Patient's date of birth
gender token Conditional Required. Patient's Gender.
_revinclude string Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Supported values: Provenance:target