RelatedPerson
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name RelatedPerson into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a patient which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “patient”
If a resource with no patient field is send to MIDATA, the backend will set the patient to the current user.
Read
Read a single RelatedPerson by id.
Request:
[GET] /fhir/RelatedPerson/<id>
Read specific version
Read a specific version of a single RelatedPerson by id.
Request:
[GET] /fhir/RelatedPerson/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/RelatedPerson/<id>/_history
Search
Search for resources of type RelatedPerson
Request:
[GET] /fhir/RelatedPerson?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 | Indicates if the related person record is active |
| address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| 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 |
| birthdate | date | The Related Person's date of birth |
| token | A value in an email contact | |
| gender | token | Gender of the related person |
| identifier | token | An Identifier of the RelatedPerson |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| patient | reference | The patient this related person is related ton |
| phone | token | A value in a phone contact |
| relationship | token | The relationship between the patient and the relatedperson |
| telecom | token | The value in any kind of contact |
Create
Create a new resource of type RelatedPerson.
Request:
[POST] /fhir/RelatedPerson
Update
Updates a resource of type RelatedPerson.
Request:
[PUT] /fhir/RelatedPerson/<id>