Patient
Role of Patient Resource on MIDATA
Each account holder has one Patient resource in his account. The resource is generated by the platform when the user account is created.
In addition if an account holder participates in a research project with pseudonymization an additional Patient resource will be created for the user. This additional resource will contain the pseudonymized Patient information.
Restrictions on “Patient”
Currently it is not possible to fully update Patient resources using the API. Only the preferred language can be changed.
Automatic Sharing
The Patient record of an account holder is automatically shared with each consent of type “Circle” or “Healthcare”.
Semantical Type
The semantical type for the platform generated Patient resource of each account holder is “Patient”. The semantical type of each Patient resource that is generated for pseudonymized project participation is “PseudonymizedPatient”.
Read
Read a single Patient by id.
Request:
[GET] /fhir/Patient/<id>
Read specific version
Read a specific version of a single Patient by id.
Request:
[GET] /fhir/Patient/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Patient/<id>/_history
Search
Search for resources of type Patient
Request:
[GET] /fhir/Patient?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | string | The resource identity |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| active | token | Whether the patient record is active |
| address | string | An address in any kind of address/part of the patient |
| address-city | string | A city specified in an address |
| address-country | string | A country specified in an address |
| address-postalcode | string | A postalCode specified in an address |
| address-state | string | A state specified in an address |
| address-use | token | A use code specified in an address |
| animal-breed | token | The breed for animal patients |
| animal-species | token | The species for animal patients |
| birthdate | date | The patient's date of birth |
| deathdate | date | The date of death has been provided and satisfies this search value |
| deceased | token | This patient has been marked as deceased, or as a death date entered |
| token | A value in an email contact | |
| family | string | A portion of the family name of the patient |
| gender | token | Gender of the patient |
| general-practitioner | reference | Patient's nominated care provider, could be a care manager, not the organization that manages the record |
| given | string | A portion of the given name of the patient |
| identifier | token | A patient identifier |
| language | token | Language code (irrespective of use value) |
| link | reference | All patients linked to the given patient |
| name | string | A portion of either family or given name of the patient |
| organization | reference | The organization at which this person is a patient |
| phone | token | A value in a phone contact |
| phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm |
| telecom | token | The value in any kind of telecom details of the patient |
Create
Create a new resource of type Patient.
Request:
[POST] /fhir/Patient Creating a new Patient resource will actually create a new MIDATA user account. Read the Guide for creation of user accounts with the API.
Update
Updates a resource of type Patient.
Request:
[PUT] /fhir/Patient/<id>