FHIR API: Patient Creation v1
Note
This API version will be deprecated. We encourage you to migrate to the latest version of the API. You can find the documentation for the new API version at Patient Creation v2.
Pre-requisites
Resource:
POST /partners/fhir/stu3/api/Bundle
Authentication:
Endpoint is secured with mutual TLS. More information can be found here: API Authentication
API Request
Request Headers
| Name | Description | Type | Required | Example |
|---|---|---|---|---|
| org_id | Organization OID | String | Yes | 2.16.724.4.2 |
| x-origin-request-id | Request Unique ID generated by EMR middleware (UUID) | String | Yes | 5109d51b-421e-4746-b673-16e3fe2b3442 |
| client_id | Public identifier for organizations generated by Roche DC | String | Yes | 1234567890 |
| client_secret | Client related secret known only to the EMR and Roche DC | String | Yes | 1234567890 |
| Content-Type | json or fhir+json | String | Yes | application/json or application/fhir+json |
Profile overview
The list of profiles used in Patient Creation.
- message-header (mandatory)
- patient-v2 (mandatory)
- condition (optional)
Note
While creating a patient, the patient identifier value and the email must be unique.
Request Example
Body Request Example:
- Refer Patient Request example with Type-1 diabetes condition:
curl --location --request POST 'https://api-services-eu.rochedcplatform.com/partners/fhir/stu3/api/v2/Bundle' \ --header 'client_id: 1234567890' \ --header 'client_secret: 1234567890' \ --header 'Content-Type: application/fhir+json' \ --header 'org_Id: 2.16.724.4.2' \ --data-raw '{ "resourceType": "Bundle", "type": "message", "entry": [ { "resource": { "resourceType": "MessageHeader", "id": "88a37162-3d7c-41c3-89ab-6e25fd68ba00", "event": { "code": "new-bundle", "system": "http://roche.com/fhir/rdc/message-type", "display": "New bundle generated" }, "source": { "endpoint": "<Organization OID>", "software": "EMR middleware", "version": "1.0.0" }, "timestamp": "2020-03-27T12:21:39.471Z", "meta": { "profile": [ "http://roche.com/fhir/rdc/StructureDefinition/message-header" ] } } }, { "resource": { "resourceType": "Patient", "meta": { "profile": [ "http://roche.com/fhir/rdc/StructureDefinition/patient-v2" ] }, "identifier": [ { "system": "urn:oid:2.16.724.4.41", "value": "12345678Z" } ], "name": [ { "family": "Doe", "given": [ "John" ] } ], "telecom": [ { "system": "phone", "value": "123123123" }, { "system": "email", "value": "johndoe123@email.com" } ], "gender": "male", "birthDate": "1991-01-01" } }, { "resource": { "resourceType": "Condition", "clinicalStatus": "active", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "426875007", "display": "Latent autoimmune diabetes mellitus in adult (disorder)" } ] }, "subject": { "reference": "Patient/sample-id-454b-b5c7-f1ed1fb4ght" } } } ] }'
API Response
API code response
| HTTP Response Code | Description | Response Body | FHIR error code | FHIR error code description |
|---|---|---|---|---|
| 200 | Patient Bundle created | Bundle | NA | NA |
| 400 | Request failed because of incorrect parameters, returns no data | OperationOutcome | required | Request failed because of incorrect parameters, returns no data |
| 400 | Request failed because of incorrect parameters, returns no data | OperationOutcome | structure | A structural issue in the content such as wrong namespace, or unable to parse the content completely, or invalid json syntax. |
| 400 | Request failed because of incorrect parameters, returns no data | OperationOutcome | invalid | Content invalid against the specification or a profile. |
| 401 | Request failed with unauthorized access, returns no data | Empty | NA | NA |
| 405 | Method Not Allowed | Empty | NA | NA |
| 409 | Conflict / User already exists | OperationOutcome | duplicate | Patient is already in use for this department. |
| 415 | Unsupported Media Type | OperationOutcome | not-supported | Content-Type is not one of (application/json, application/fhir+json) |
| 500 | Request failed with internal exception | OperationOutcome | exception | Internal server error. |
| 501 | Not implemented | Empty | NA | NA |
API Payload response
Successful response object:
{
"resourceType": "Bundle",
"type": "message",
"entry": [
{
"resource": {
"resourceType": "MessageHeader",
"id": "88a37162-3d7c-41c3-89ab-6e25fd68ba00",
"event": {
"code": "new-bundle",
"system": "http://roche.com/fhir/rdc/message-type",
"display": "New bundle generated"
},
"source": {
"endpoint": "<Organization OID>",
"software": "EMR middleware",
"version": "1.0.0"
},
"timestamp": "2020-03-27T12:21:39.471Z",
"meta": {
"profile": [
"http://roche.com/fhir/rdc/StructureDefinition/message-header"
]
}
}
},
{
"resource": {
"resourceType": "Patient",
"meta": {
"profile": [
"http://roche.com/fhir/rdc/StructureDefinition/patient-v2"
]
},
"id": "12345678Z",
"identifier": [
{
"system": "urn:oid:2.16.724.4.41",
"value": "12345678Z"
}
],
"name": [
{
"family": "Doe",
"given": [
"John"
]
}
],
"telecom": [
{
"system": "phone",
"value": "123123123"
},
{
"system": "email",
"value": "johndoe123@email.com"
}
],
"gender": "male",
"birthDate": "1991-01-01"
}
},
{
"resource": {
"resourceType": "Condition",
"clinicalStatus": "active",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "426875007",
"display": "Latent autoimmune diabetes mellitus in adult (disorder)"
}
]
},
"subject": {
"reference": "Patient/sample-id-454b-b5c7-f1ed1fb4ght"
}
}
}
]
}
Error response object:
As an example, If we try to create a record that already existis in Roche Diabetes Care (RDC), a 409 HTTP error status code is returned together the following response:
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "duplicate",
"diagnostics": "Patient is already in use for this department."
}
]
}
Response Time (ms):
Average: 1500
Worst case scenario: 10000