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
  • Retrieve specific Resource
  • Retrieve specific version of a Resource (vread)
  • Topics

Was this helpful?

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

Retrieve specific Resource

Request a specific instance of a Resource

PreviousRetrieve all ResourcesNextCreate a Resource

Last updated 8 months ago

Was this helpful?

See the for more information.

Retrieve specific Resource

GET https://hapi-fhir-server.koppeltaal.headease.nl/fhir/<Resource>/<:id>

Path Parameters

Name
Type
Description

id*

string

Resource.id to be retrieved

Headers

Name
Type
Description

Authentication*

string

Bearer token obtained from the Auth Server (see

)

{
    "resourceType": "Patient",
    "id": "13befac2-de72-4926-99e8-24d0adb1fd62",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2023-01-17T08:52:04.997+00:00",
        "source": "urn:uuid:c712f204-abe7-4ec1-bad0-6dc3dfa1afd8#26be13a5038c6a77",
        "profile": [
            "http://koppeltaal.nl/fhir/StructureDefinition/KT2Patient"
        ]
    },
    "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">null <b>SUITE </b></div><table class=\"hapiPropertyTable\"><tbody><tr><td>Identifier</td><td>6cc2bea5</td></tr><tr><td>Date of birth</td><td><span>17 January 2023</span></td></tr></tbody></table></div>"
    },
    "extension": [
        {
            "url": "http://koppeltaal.nl/fhir/StructureDefinition/resource-origin",
            "valueReference": {
                "reference": "Device/9f3ac641-bf1a-4f62-82b2-9825f80e6847",
                "type": "Device"
            }
        }
    ],
    "identifier": [
        {
            "system": "https://koppeltaal.nl/identifier/TestSuiteIdentifier",
            "value": "6cc2bea5"
        }
    ],
    "active": true,
    "name": [
        {
            "use": "official",
            "family": "Suite",
            "given": [
                null
            ],
            "_given": [
                {
                    "extension": [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                            "valueCode": "IN"
                        }
                    ]
                }
            ]
        }
    ],
    "gender": "male",
    "birthDate": "2023-01-17"
}

Unauthenticated

Unauthorized

Not Found Resource with id does not exist
Gone Resource has been deleted

Retrieve specific version of a Resource (vread)

GET https://hapi-fhir-server.koppeltaal.headease.nl/fhir/<Resource>/<:id>/_history/<:versie>

Path Parameters

Name
Type
Description

id*

String

Resource.id to be retrieved

versie*

Integer

The version

Headers

Name
Type
Description

Authorization*

String

Bearer token verkregen via de Auth Server

{
    "resourceType": "Patient",
    "id": "13befac2-de72-4926-99e8-24d0adb1fd62",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2023-01-17T08:52:04.997+00:00",
        "source": "urn:uuid:c712f204-abe7-4ec1-bad0-6dc3dfa1afd8#26be13a5038c6a77",
        "profile": [
            "http://koppeltaal.nl/fhir/StructureDefinition/KT2Patient"
        ]
    },
    "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">null <b>SUITE </b></div><table class=\"hapiPropertyTable\"><tbody><tr><td>Identifier</td><td>6cc2bea5</td></tr><tr><td>Date of birth</td><td><span>17 January 2023</span></td></tr></tbody></table></div>"
    },
    "extension": [
        {
            "url": "http://koppeltaal.nl/fhir/StructureDefinition/resource-origin",
            "valueReference": {
                "reference": "Device/9f3ac641-bf1a-4f62-82b2-9825f80e6847",
                "type": "Device"
            }
        }
    ],
    "identifier": [
        {
            "system": "https://koppeltaal.nl/identifier/TestSuiteIdentifier",
            "value": "6cc2bea5"
        }
    ],
    "active": true,
    "name": [
        {
            "use": "official",
            "family": "Suite",
            "given": [
                null
            ],
            "_given": [
                {
                    "extension": [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                            "valueCode": "IN"
                        }
                    ]
                }
            ]
        }
    ],
    "gender": "male",
    "birthDate": "2023-01-17"
}

Unauthenticated

Unauthorized

Resource with id does not exist

Gone Resource has been deleted

Topics

(zie )

FHIR documentation
TOP-KT-002a - FHIR Resource Service interacties
TOP-KT-003 - Logische ID, bedrijfsidentifier, referenties en referentie integriteit
TOP-KT-005a - Rollen en rechten voor applicatie-instanties
TOP-KT-009 - Overzicht gebruikte FHIR Resources
Connecting to Koppeltaal
Connecting to Koppeltaal