Person

See FHIR specification

Role of Person Resource on MIDATA

For each user of the platform -regardless of its role- one Person resource is created and managed by the platform.

Managed Resource

The Person resource is managed by the MIDATA platform. It is not possible to create or update instances of this resource using the API.

If you search for person resources one of these conditions must be met or the search will return an error 400:

  • search is restricted by _id
  • search is restricted by email
  • search is restricted by name and birthday

Please note that user accounts with profiles not set to visible will not be included in the search result.

Also note that the search result will only be returned if it contains 5 or less resources.

An AuditEvent will be stored for each user searched. Each user may read its own Person resource without creating an AuditEvent.

Semantical type

The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name Person into your applications access filter if you need to use this resource.

Resource owner

As the resource is completely managed by the platform there is no resource owner.

Read

Read a single Person by id. If you try to read a Person resource by id that is existing but the profile is not set to visible (and its not your own Person resource) you will receive an almost empty person resource as result:

{
  "resourceType": "Person",
  "id": "3e3c653ee4afbc6dbb080804",
  "link": [
    {
      "target": {
        "reference": "Patient/3e3c653ee4afbc6dbb080804"
      }
    }
  ]
}

Request:

[GET] /fhir/Person/<id>

Search for resources of type Person

Request:

[GET] /fhir/Person?searchParams

List of supported search parameters:

Supported query parameters:

Name Type Description
_id string The resource identity
address string A server defined search that may match any of the string fields in the Address, including line, city, 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 postal code specified in an address
birthdate date The person's date of birth
email token A value in an email contact
gender token The gender of the person
identifier token A person Identifier
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