Koppeltaal 2.0 Dev Guide
  • Developer Guide
  • POC (Walking Skeleton)
    • Proof Of Concept
      • Koppeltaal Server
      • Domain Management
      • Auth Server
      • Koppeltaal IdP
      • Domain Access Test Suite
      • Koppeltaal Test Tooling
  • Domain access
    • Joining a domain
    • Role-based access control
      • Autorisation model
      • Creating a role
      • Search Narrowing
      • Revoke Permission
  • Technical HOW-TO
    • Koppeltaal Test Tooling
    • Request Koppeltaal server metadata
    • Connecting to Koppeltaal
      • Requirements
        • Create a key pair
        • Signing the JWT
        • JWKS setup
      • Access to Koppeltaal
    • Managing resources
      • Versioning
      • CRUD Operations
        • Retrieve all Resources
        • Retrieve specific Resource
        • Create a Resource
        • Update a Resource
        • Delete a Resource
      • Subscribing to changes
    • Launching
      • HTI Flow
      • SHOF Flow
      • Compose a launch
      • Initiating a launch
      • Receiving a HTI launch
        • Token introspection
      • Receiving a SHOF launch
    • Detailed technical guidance
  • Hackathon Use Cases
    • Requirements
      • Install and configure Yivi
    • Use-Cases
      • Use-Case 1: Create a Task
        • Create an ActivityDefinition
      • Use-Case 2: HTI Launch
      • Use-case 3: SHOF Launch
      • Use-case 4: Subscribing to changes
  • Useful Links
    • Simplifier Profiles
    • FHIR Docs
    • HTI documentation
    • GitHub
    • Koppeltaal 2.0 Specifications & Architecture
    • Koppeltaal 2.0 Implementation Guide
    • Koppeltaal 2.0 OpenAPI Specs
Powered by GitBook
On this page
  • Business identifiers
  • Koppeltaal Profiles
  • Conditional Create
  • Conditional Create Request
  • Create Request
  • Topics

Was this helpful?

  1. Technical HOW-TO
  2. Managing resources
  3. CRUD Operations

Create a Resource

PreviousRetrieve specific ResourceNextUpdate a Resource

Last updated 8 months ago

Was this helpful?

See the 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 . Profiles are stored in FHIR as 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 :

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.

Conditional Create Request

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

Headers

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

Request Body

Name
Type
Description

*

object

Resource

The resource already existed. The POST was not processed.

Resource is created. The resource with resource-origin extension and id is returned.

The resource cannot be parsed or does not conform to the basic FHIR validation rules

Unauthenticated

Unauthorized

Resource type is not supported

More than one match found. The If-None-Exist is not selective enough.

Does not meet FHIR profiles or Koppeltaal business rules

Create Request

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

Headers

Name
Type
Description

Content-type*

String

application/fhir+json

OR

application/fhir+xml

Authorization*

string

Bearer token obtained from the Auth Server

\

(see

)

Request Body

Name
Type
Description

*

object

Resource

Resource is created. The resource with resource-origin extension and id is returned.

The resource cannot be parsed or does not conform to the basic FHIR validation rules

Unauthenticated

Unauthorized

Resource type is not supported

Does not meet FHIR profiles or Koppeltaal business rules

Topics

The FHIR specification describes . 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.

(see )

conditional creates
TOP-KT-002a - FHIR Resource Service interacties
TOP-KT-005a - Rollen en rechten voor applicatie-instanties
TOP-KT-009 - Overzicht gebruikte FHIR Resources
Connecting to Koppeltaal
Connecting to Koppeltaal
FHIR documentation
Koppeltaal profiles
StructureDefinition
simplifier
Canonical identifier ophalen bij simplifier.net