Practitioner

See FHIR specification

MIDATA specific use

Each healthcare provider account on the MIDATA platform corresponds to one Practitioner resource. The Practitioner resource is only visible to the practitioner himself unless the account is set to visible in the MIDATA portal. If the account is visible the corresponding practitioner resource is public.

Practitioner resources that belong to a healthcare provider account are generated by the platform and are read-only.

Hybrid use

This FHIR resource may be used in two different ways on the MIDATA platform. It may be used as a “normal” FHIR resource in order to store data or it may be used as part of built-in functionality of the platform. In the later case each instance of the resource corresponds to an entity of the platform.

Semantical type

The semantical type is “Practitioner/Extern” if the resource is used for data storage without additional platform logic. Otherwise the semantical type is “Practitioner”.

If you need access to this FHIR resource you need to add either one or both of the content types to the access filter.

If an instance of the Practitioner FHIR resource is treated as normal FHIR resource or with MIDATA platform logic is based on the resource content.

If a Practitioner resource contains the following security-tag it will be treated as a Practitioner resource belonging to a healthcare provider account:

{
  "resourceType" : "Practitioner",
  "meta" : {
     "security": [
        {
          "system": "http://midata.coop/codesystems/security",
          "code": "generated",
          "display": "Generated Resource"
        }
     ]
  }
}

Resource owner

The creator of the resource is always the owner of the resource. Here is an example of a non-MIDATA practitioner resource:

{
  "resourceType" : "Practitioner",
  "identifier" : [
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://snomed.info/sct",
            "code" : "62247001",
            "display" : "Family doctor"
          }
        ]
      },
      "system" : "http://midata.coop/family-doctor-of-patient",
      "value" : "5d5eb44dcf5693096aa4e9b6"
    },
    {
      "type" : {
        "coding" : [
          {
            "system" : "http://hl7.org/fhir/R4/v2/0203/index.html",
            "code" : "PRN",
            "display" : "Provider number"
          }
        ]
      },
      "system" : "urn:oid:2.51.1.3",
      "value" : "7601000737151"
    }    
  ],
  "active" : true,
  "name" : [
    {
      "family" : "Bernasconi",
      "given" : "Arnaud"
    }
  ],
  "telecom" : [
    {
      "system" : "phone",
      "value" : "+41 22 748 49 70"
    }
  ],
  "address" : [
    {
      "use" : "work",
      "type" : "physical",
      "line" : [
        "Centre commercial de Balexert"
      ],
      "city" : "Genève",
      "district" : "28",
      "postalCode" : "1201"
    }
  ],
  "gender" : "male"
}

Read

Read a single Practitioner by id.

Request:

[GET] /fhir/Practitioner/<id>

Read specific version

Read a specific version of a single Practitioner by id.

Request:

[GET] /fhir/Practitioner/<id>/_history/<version>

Retrieve history

Retrieve all versions of a single resource.

Request:

[GET] /fhir/Practitioner/<id>/_history

Search for resources of type Practitioner

Request:

[GET] /fhir/Practitioner?searchParams

List of supported search parameters:

Supported query parameters:

Name Type Description
_id string The resource identity
_page string  
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

Create

Create a new resource of type Practitioner.

Request:

[POST] /fhir/Practitioner

Update

Updates a resource of type Practitioner.

Request:

[PUT] /fhir/Practitioner/<id>