Organization

See FHIR specification

MIDATA specific use

Each healthcare provider on the MIDATA platform corresponds to one Organization resource. These resources are automatically maintained by the platform, but may also be updated using the API. An API update will also change the entity on MIDATA.
Also for each research organization a resource is created and maintained by the platform. In addition to these platform-mapped resources it is possible to create and update data-only Organization resources that do not correspond to an entity on the platform.

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 “Organization” if the resource is used for data storage without additional platform logic. Otherwise the semantical type is “Organization/HP or Organization/Research”.

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 Organization FHIR resource is treated as normal FHIR resource or with MIDATA platform logic is based on the resource content.

Whether an Organization resource represents an entity on the platform or is just a data resource is determined by the “platform-mapped” security tag. A new Organization created using the API will be treated as normal FHIR resource. If you want to create an Organization entity on Midata the following security tag must be included in the resource upon creation time:

{
  "resourceType" : "Organization",
  "meta" : {
     "security": [
        {
          "system": "http://midata.coop/codesystems/security",
          "code": "platform-mapped"
        }
     ]
  }
}

The platform will automatically generate Organization resources for each healthcare provider registered and for each research organization. If an existing Organization resource contains the “platform-mapped” security-tag it will be treated as a Organization resource belonging to a healthcare provider or research.

Public resource

This resource is used as a public resource without access restrictions.

However, it is important that you specify in the access filter of your application that you want to use this public resource.

Update permission

A platform-mapped Organization resource may only be updated by an entity that has management permissions for the Organization.

Using the API it is possible to add a Practitioner as manager upon creation or update using a FHIR extension:

{
  "resourceType" : "Organization",
  "extension" : [
    {
      "url": "http://midata.coop/extensions/managed-by",
      "valueReference" : {
          "reference": "Practitioner/1234",          
      }
    }   
  ]
  
}

Read

Read a single Organization by id.

Request:

[GET] /fhir/Organization/<id>

Read specific version

Read a specific version of a single Organization by id.

Request:

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

Retrieve history

Retrieve all versions of a single resource.

Request:

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

Search

Search for resources of type Organization

Request:

[GET] /fhir/Organization?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	Is the Organization record 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 Organization.address
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
endpoint	reference	Technical endpoints providing access to services operated for the organization
identifier	token	Any identifier for the organization (not the accreditation issuer's identifier)
name	string	A portion of the organization's name or alias
partof	reference	An organization of which this organization forms a part
phonetic	string	A portion of the organization's name using some kind of phonetic matching algorithm
type	token	A code for the type of organization

Create

Create a new resource of type Organization.

Request:

[POST] /fhir/Organization

Update

Updates a resource of type Organization.

Request:

[PUT] /fhir/Organization/<id>