{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"12d3e879-ee10-4dc9-95ac-04739b1ab3da"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"2b98bdcc-901f-4b93-b615-3b2a02cacdf0"},"content":[{"type":"paragraph","content":[{"text":"Audience: This page is intended for developers and architects that are to interface with the Care Gateway","type":"text","marks":[{"type":"em"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"The Care Gateway (henceforth gateway) is a service that receives FHIR reports/bundles (eg. ","type":"text"},{"text":"care delivery reports","type":"text","marks":[{"type":"link","attrs":{"href":"https://kl-dk.github.io/website/existing-gateway/index.html"}}]},{"text":" or ","type":"text"},{"text":"children delivery reports","type":"text","marks":[{"type":"link","attrs":{"href":"https://kl-dk.github.io/website/children/StructureDefinition-klgateway-children-delivery-report.html"}}]},{"text":") from the municipalities and asynchronously forwards them other data sources such as ","type":"text"},{"text":"FLIS","type":"text","marks":[{"type":"link","attrs":{"href":"https://kombit.dk/flis"}}]},{"text":", ","type":"text"},{"text":"SEI2","type":"text","marks":[{"type":"link","attrs":{"href":"https://services.nsi.dk/en/Services/SEI2"}}]},{"text":", ","type":"text"},{"text":"RKKP","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.rkkp.dk/"}}]},{"text":" etc. The reports must follow the FHIR format specified in one of the allowed FHIR implementation guides:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CareDeliveryReports: ","type":"text"},{"text":"KL Gateway FHIR Implementation Guide (IG)","type":"text","marks":[{"type":"link","attrs":{"href":"https://kl-dk.github.io/website/gateway/index.html"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ChildrenDeliveryReports: ","type":"text"},{"text":"KL-Children FHIR Implementation Guide (IG)","type":"text","marks":[{"type":"link","attrs":{"href":"https://kl-dk.github.io/website/children/artifacts.html"}}]},{"text":" (Only on TEST001)","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Any report received by the gateway is validated against the profiles and terminology resources specified in the relevant IG. Failing to comply with these resources will result in an 4XX error.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Security","type":"text"}]},{"type":"paragraph","content":[{"text":"In order for a client to send reports to the gateway the client needs to obtain a valid access token. For authentication and obtaining an access token (through a KeyCloak instance) see ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2187362305"}},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]},{"text":": A public key must have been forwarded ahead of time and out-of-band of the authentication flow to be successful.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Interface","type":"text"}]},{"type":"paragraph","content":[{"text":"As can be seen in the OpenAPI below, the reporting systems interacts with the gateway by PUT’ing reports to it on ","type":"text"},{"text":"https://:/fhir/Bundle","type":"text","marks":[{"type":"code"}]},{"text":". By default, FHIR servers support all CRUD operations, but HTTP PUT has been selected as the only choice for KLG, because it effectively allows clients to control the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" of the resource, hence putting the ","type":"text"},{"text":"client in control","type":"text","marks":[{"type":"link","attrs":{"href":"https://hl7.org/fhir/http.html#upsert"}}]},{"text":" (aka. ","type":"text"},{"text":"upsert","type":"text","marks":[{"type":"code"}]},{"text":"). Notice that the Bundle id chosen by the client must be globally unique, and that the id of the Bundle payload must equal the id in the URL (/fhir/Bundle/{id}). Within a Bundle (bundle entry-list), ids must only be unique within the bundle, and ","type":"text"},{"text":"may","type":"text","marks":[{"type":"em"}]},{"text":" be reused to indicate resource updates - this is specified by the individual implementation guides, see eg. section 2.1 (Reporting) of ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://kl-dk.github.io/website/gateway/index.html"}},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"It has been agreed that two subsequent PUTs will not update the existing bundle - instead, a DUPLICATE_ENTITY error will be returned (see section “Error messages” below). ","type":"text"}]},{"type":"paragraph","content":[{"text":"As stated, the content must follow the FHIR structure of an allowed IG.","type":"text"}]},{"type":"paragraph"},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"__bodyContent":{"value":"openapi: 3.0.1\ninfo:\n title: Trifork Gateway FHIR Server\n contact: {}\n version: 5.6.1\nservers:\n- url: https://care-gateway.test001.ehealth.sundhed.dk/fhir\n description: Trifork Gateway FHIR Server\ntags:\n- name: System Level Operations\n description: Server-level operations\n- name: Bundle\n description: The Bundle FHIR resource type\n- name: OperationDefinition\n description: The OperationDefinition FHIR resource type\npaths:\n /metadata:\n get:\n tags:\n - System Level Operations\n summary: \"server-capabilities: Fetch the server FHIR CapabilityStatement\"\n responses:\n \"200\":\n description: Success\n content:\n application/fhir+json:\n schema:\n $ref: '#/components/schemas/FHIR-JSON-RESOURCE'\n example: |-\n {\n \"resourceType\": \"CapabilityStatement\"\n }\n application/fhir+xml:\n schema:\n $ref: '#/components/schemas/FHIR-XML-RESOURCE'\n example: \n /Bundle/{id}:\n put:\n tags:\n - Bundle\n summary: \"update-instance: Update an existing Bundle instance, or create using\\\n \\ a client-assigned ID\"\n parameters:\n - name: id\n in: path\n description: The resource ID\n required: true\n style: simple\n schema:\n minimum: 1\n type: string\n example: \"123\"\n requestBody:\n content:\n application/fhir+json:\n schema:\n $ref: '#/components/schemas/FHIR-JSON-RESOURCE'\n example: |-\n {\n \"resourceType\": \"Bundle\"\n }\n application/fhir+xml:\n schema:\n $ref: '#/components/schemas/FHIR-XML-RESOURCE'\n example: \n responses:\n \"200\":\n description: Success\n content:\n application/fhir+json:\n schema:\n $ref: '#/components/schemas/FHIR-JSON-RESOURCE'\n application/fhir+xml:\n schema:\n $ref: '#/components/schemas/FHIR-XML-RESOURCE'\ncomponents:\n schemas:\n FHIR-JSON-RESOURCE:\n type: object\n description: A FHIR resource\n FHIR-XML-RESOURCE:\n type: object\n description: A FHIR resource"}},"macroMetadata":{"macroId":{"value":"6ccd7f81-96f7-4ec0-99fe-649cd247c517"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"eceeadc9-2108-4442-9009-04830308b0ab"}},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Business Flow","type":"text"}]},{"type":"paragraph","content":[{"text":"The temporal aspects of the business processes are depicted below. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wide","width":100.0},"content":[{"type":"media","attrs":{"width":1557,"id":"4db3d323-339d-4e0f-ab05-0821eb5d852c","collection":"contentId-2189361157","type":"file","height":1529}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Technical Flow","type":"text"}]},{"type":"paragraph","content":[{"text":"The technical interaction between the different parties is as depicted below. Actions within the green box are of high relevance to the audience of this page. The interaction between the gateway (white box) and 3.party systems (blue box) is shown for sake of completeness.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":100.0},"content":[{"type":"media","attrs":{"width":1009,"id":"cd86b0f0-ad02-4bb8-a81a-50f2929f6526","collection":"contentId-2189361157","type":"file","height":1263}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error messages","type":"text"}]},{"type":"paragraph","content":[{"text":"The Care Gateway may return error messages in case of invalid input, technical errors etc. according to standard HAPI FHIR behaviour. All errors are reported using the OperationOutcome profile, which is described her:","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://www.hl7.org/fhir/operationoutcome.html"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Apart from standard HAPI FHIR errors, the gateway may return this custom error in case a bundle with the specified bundle ID has already been created:","type":"text"}]},{"type":"paragraph","content":[{"text":"DUPLICATE_ENTITY","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"Entity with id '%s' already exists","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"diagnostics\": \"DUPLICATE_ENTITY: Entity with id 'Bundle/0c1112c3-77b5-4d85-965c-0c26228ec7e3' already exists\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is also an example of a validation error (in case the input does not conform to the implementation guide):","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"diagnostics\": \"Unable to find a match for profile Condition/ad506910-9030-4ddb-b8ce-7bb6a69d808e among choices: http://gateway.kl.dk/1.0/StructureDefinition/klgateway-care-condition, http://gateway.kl.dk/1.0/StructureDefinition/klgateway-care-planned-intervention\",\n \"location\": [\n \"Bundle.entry[5].resource.ofType(Observation).focus[0]\",\n \"Line 238, Col 12\"\n ]\n },\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"diagnostics\": \"Encounter.period: minimum required = 1, but only found 0 (from http://gateway.kl.dk/1.0/StructureDefinition/klgateway-care-encounter)\",\n \"location\": [\n \"Bundle.entry[6].resource.ofType(Encounter)\",\n \"Line 282, Col 22\"\n ]\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Issues","type":"text"}]},{"type":"paragraph","content":[{"text":"If you encounter a bug or an issue with the gateway or the security component/flow please report it as an issue on ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://github.com/trifork/klg-docs"}},{"text":". ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Test environment","type":"text"}]},{"type":"paragraph","content":[{"text":"Details on the gateway test environment can be found on ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2188738578"}},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"Snippet below shows an example CareDeliveryReport request without security headers","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"PUT http://localhost:8080/fhir/Bundle/0c1112c3-77b5-4d85-965c-0c26228ec7ef\nContent-Type: application/json\n\n{\n \"resourceType\" : \"Bundle\",\n \"id\" : \"0c1112c3-77b5-4d85-965c-0c26228ec7ef\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-delivery-report\"\n ]\n },\n \"type\" : \"collection\",\n \"timestamp\" : \"2021-02-14T15:23:12Z\",\n \"entry\" : [\n {\n \"fullUrl\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\",\n \"resource\" : {\n \"resourceType\" : \"Patient\",\n \"id\" : \"4a45e179-ace1-4ace-9991-8276c0ba490a\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-citizen\"\n ]\n },\n \"text\" : {\n \"status\" : \"generated\",\n \"div\" : \"

Generated Narrative

identifier: id: 0101570001 (OFFICIAL)

managingOrganization:

\"\n },\n \"identifier\" : [\n {\n \"use\" : \"official\",\n \"system\" : \"urn:oid:1.2.208.176.1.2\",\n \"value\" : \"0101570001\"\n }\n ],\n \"managingOrganization\" : {\n \"identifier\" : {\n \"use\" : \"official\",\n \"system\" : \"urn:oid:1.2.208.176.1.1\",\n \"value\" : \"123456789012345\"\n }\n }\n }\n },\n {\n \"fullUrl\" : \"Condition/a881788d-1b27-46e3-8b76-607bc49876fd\",\n \"resource\" : {\n \"resourceType\" : \"Condition\",\n \"id\" : \"a881788d-1b27-46e3-8b76-607bc49876fd\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-condition\"\n ]\n },\n \"text\" : {\n \"status\" : \"generated\",\n \"div\" : \"

Generated Narrative

clinicalStatus: Inactive

code: Respirationsproblemer

subject: See above (Patient/4a45e179-ace1-4ace-9991-8276c0ba490a)

recordedDate: 2021-02-10

\"\n },\n \"clinicalStatus\" : {\n \"coding\" : [\n {\n \"system\" : \"http://terminology.hl7.org/CodeSystem/condition-clinical\",\n \"code\" : \"inactive\"\n }\n ]\n },\n \"code\" : {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/FSIII\",\n \"code\" : \"I7.1\"\n }\n ]\n },\n \"subject\" : {\n \"reference\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\"\n },\n \"recordedDate\" : \"2021-02-10\"\n }\n },\n {\n \"fullUrl\" : \"Condition/ad506910-9030-4ddb-b8ce-7bb6a69d808e\",\n \"resource\" : {\n \"resourceType\" : \"Condition\",\n \"id\" : \"ad506910-9030-4ddb-b8ce-7bb6a69d808e\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-condition\"\n ]\n },\n \"text\" : {\n \"status\" : \"extensions\",\n \"div\" : \"

Generated Narrative

CareFollowUpEncounterExtension: See above (Encounter/1fb0990d-aac7-4661-b976-874e051c5ae6)

clinicalStatus: Active

category: Problem List Item

code: Problemer med mobilitet og bevægelse

subject: See above (Patient/4a45e179-ace1-4ace-9991-8276c0ba490a)

recordedDate: 2021-02-10

\"\n },\n \"extension\" : [\n {\n \"url\" : \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-follow-up-encounter-extension\",\n \"valueReference\" : {\n \"reference\" : \"Encounter/1fb0990d-aac7-4661-b976-874e051c5ae6\"\n }\n }\n ],\n \"clinicalStatus\" : {\n \"coding\" : [\n {\n \"system\" : \"http://terminology.hl7.org/CodeSystem/condition-clinical\",\n \"code\" : \"active\"\n }\n ]\n },\n \"category\" : [\n {\n \"coding\" : [\n {\n \"system\" : \"http://terminology.hl7.org/CodeSystem/condition-category\",\n \"code\" : \"problem-list-item\"\n }\n ]\n }\n ],\n \"code\" : {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/FSIII\",\n \"code\" : \"I2.1\"\n }\n ]\n },\n \"subject\" : {\n \"reference\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\"\n },\n \"recordedDate\" : \"2021-02-10\"\n }\n },\n {\n \"fullUrl\" : \"Observation/c9c93481-f170-4653-b837-6e8eacd716ca\",\n \"resource\" : {\n \"resourceType\" : \"Observation\",\n \"id\" : \"c9c93481-f170-4653-b837-6e8eacd716ca\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-matter-of-interest-observation\"\n ]\n },\n \"text\" : {\n \"status\" : \"generated\",\n \"div\" : \"

Generated Narrative

code: Respiration og cirkulation

subject: See above (Patient/4a45e179-ace1-4ace-9991-8276c0ba490a)

effective: 2021-02-15

value: Ikke relevant

\"\n },\n \"status\" : \"final\",\n \"code\" : {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/FSIII\",\n \"code\" : \"I7\"\n }\n ]\n },\n \"subject\" : {\n \"reference\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\"\n },\n \"effectiveDateTime\" : \"2021-02-15\",\n \"valueCodeableConcept\" : {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/FSIII\",\n \"code\" : \"B6\"\n }\n ]\n }\n }\n },\n {\n \"fullUrl\" : \"Observation/c0e46d1a-bcd2-4b4f-bc74-db1237157d4e\",\n \"resource\" : {\n \"resourceType\" : \"Observation\",\n \"id\" : \"c0e46d1a-bcd2-4b4f-bc74-db1237157d4e\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-follow-up-observation\"\n ]\n },\n \"text\" : {\n \"status\" : \"generated\",\n \"div\" : \"

Generated Narrative

code: Evaluation of care plan (procedure)

subject: See above (Patient/4a45e179-ace1-4ace-9991-8276c0ba490a)

focus: See above (Condition/a881788d-1b27-46e3-8b76-607bc49876fd)

effective: 2021-02-12

value: Afsluttes

\"\n },\n \"status\" : \"final\",\n \"code\" : {\n \"coding\" : [\n {\n \"system\" : \"http://snomed.info/sct\",\n \"code\" : \"712744002\"\n }\n ]\n },\n \"subject\" : {\n \"reference\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\"\n },\n \"focus\" : [\n {\n \"reference\" : \"Condition/a881788d-1b27-46e3-8b76-607bc49876fd\"\n }\n ],\n \"effectiveDateTime\" : \"2021-02-12\",\n \"valueCodeableConcept\" : {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/FSIII\",\n \"code\" : \"E3\"\n }\n ]\n }\n }\n },\n {\n \"fullUrl\" : \"Observation/4c160af3-dc6f-4405-a52a-b93447e06b68\",\n \"resource\" : {\n \"resourceType\" : \"Observation\",\n \"id\" : \"4c160af3-dc6f-4405-a52a-b93447e06b68\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-follow-up-observation\"\n ]\n },\n \"text\" : {\n \"status\" : \"generated\",\n \"div\" : \"

Generated Narrative

code: Evaluation of care plan (procedure)

subject: See above (Patient/4a45e179-ace1-4ace-9991-8276c0ba490a)

focus: See above (Condition/ad506910-9030-4ddb-b8ce-7bb6a69d808e)

effective: 2021-02-14

value: Ændres inden for rammen

\"\n },\n \"status\" : \"final\",\n \"code\" : {\n \"coding\" : [\n {\n \"system\" : \"http://snomed.info/sct\",\n \"code\" : \"712744002\"\n }\n ]\n },\n \"subject\" : {\n \"reference\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\"\n },\n \"focus\" : [\n {\n \"reference\" : \"Condition/ad506910-9030-4ddb-b8ce-7bb6a69d808e\"\n }\n ],\n \"effectiveDateTime\" : \"2021-02-14\",\n \"valueCodeableConcept\" : {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/FSIII\",\n \"code\" : \"E2\"\n }\n ]\n }\n }\n },\n {\n \"fullUrl\" : \"Encounter/1fb0990d-aac7-4661-b976-874e051c5ae6\",\n \"resource\" : {\n \"resourceType\" : \"Encounter\",\n \"id\" : \"1fb0990d-aac7-4661-b976-874e051c5ae6\",\n \"meta\" : {\n \"profile\" : [\n \"http://fhir.kl.dk/gatewayStructureDefinition/klgateway-care-encounter\"\n ]\n },\n \"text\" : {\n \"status\" : \"generated\",\n \"div\" : \"

Generated Narrative

status: planned

class: home health

type: opfølgning

subject: See above (Patient/4a45e179-ace1-4ace-9991-8276c0ba490a)

period: 2021-02-15 --> (ongoing)

\"\n },\n \"status\" : \"planned\",\n \"class\" : {\n \"system\" : \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\" : \"HH\"\n },\n \"type\" : [\n {\n \"coding\" : [\n {\n \"system\" : \"http://kl.dk/fhir/common/caresocial/CodeSystem/KLCommonCareSocialCodes\",\n \"code\" : \"9f03dfbb-7a97-45a5-94db-d4c3501714a9\"\n }\n ]\n }\n ],\n \"subject\" : {\n \"reference\" : \"Patient/4a45e179-ace1-4ace-9991-8276c0ba490a\"\n },\n \"period\" : {\n \"start\" : \"2021-02-15\"\n }\n }\n }\n ]\n}","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported