Create a Resource

See the FHIR documentation for more information.

Business identifiers

Koppeltaal enforces setting business identifiers on Resources by making the identifier field mandatory. The main reason for this is so that a source system can consistently keep track of whether a Koppeltaal variant of their entity already exists. In addition, business identifiers can help when there are multiple source systems that need to know if a Resource already exists.

Koppeltaal Profiles

The Koppeltaal server validates all Resources being created or updated. The server enforces that resources are sent in compliance with the Koppeltaal profiles. Profiles are stored in FHIR as StructureDefinition resources. To indicate that a resource has been created in compliance with a profile, the Resource.meta.profiles array must be filled. The value should always be filled with the canonical identifier of the profile. This can be found in simplifier:

For example:

{
  "resourceType": "Subscription",
  "meta": {
    "profile": [
      "http://koppeltaal.nl/fhir/StructureDefinition/KT2Subscription"
    ]
  }
  ...
  }
}

Conditional Create

The conditional create is still in the "trial use" phase. Thus, the status of this functionality has yet to be reviewed.

The FHIR specification describes conditional creates. When a Resource is created, an upsert can be performed based on the business identifier. When multiple applications in a domain create the same type of Resources, it is important that there is clear agreement on which identifier system is used. The conditional create helps prevent duplicate resources being created at Koppeltaal.

Conditional Create Request

POST https://fhir-server.koppeltaal.headease.nl/fhir/DEFAULT/<Resource>

Headers

Name Type Description

Name	Type	Description
Content-Type*	String	`application/fhir+json` OR `application/fhir+xml`
If-None-Exist*	string	The business identifier, e.g: `identifier=http://my-lab-system\|123`
Authorization*	string	Bearer token obtained from the Auth Server \ (see Connecting to Koppeltaal )

Content-Type*

String

application/fhir+json

application/fhir+xml

If-None-Exist*

string

The business identifier, e.g:

identifier=http://my-lab-system|123

Authorization*

string

Bearer token obtained from the Auth Server

(see

Connecting to Koppeltaal

)

Request Body

Name	Type	Description
*	object	Resource

Name

Type

Description

object

Resource

Create Request

POST https://fhir-server.koppeltaal.headease.nl/fhir/DEFAULT/<Resource>

Headers

Name Type Description

Name	Type	Description
Content-type*	String	`application/fhir+json` OR `application/fhir+xml`
Authorization*	string	Bearer token obtained from the Auth Server \ (see Connecting to Koppeltaal )

Content-type*

String

application/fhir+json

application/fhir+xml

Authorization*

string

Bearer token obtained from the Auth Server

(see

Connecting to Koppeltaal

)