Skip to content

FHIR base URL

Overview

As required by HTI-1 all IT Modules certified to § 170.315(g)(10) shall expose an open endpoint with information about the organization that operates the system and the endpoint (web address) to the capability statement.

Kodjin has an URL to create and manage a Bundle for HTI-1 requirements. The Bundle should be created manually by the system administrator (operator). Example of the Bundle you can find at the end of this page.

This method requires the following scopes:
- system/kodjin/fhir-base-url
- user/kodjin/fhir-base-url
You can read more about smart-on-FHIR scopes on SMART on FHIR Authorization page

As all endpoints require scope to make the GET operation public use rbac routes config file.

Endpoints

POST [fhir_base]/fhir/fhir-base-url

GET [fhir_base]/fhir/fhir-base-url

PUT [fhir_base]/fhir/fhir-base-url

DELETE [fhir_base]/fhir/fhir-base-url

Examples

GET Bundle with Endpoint and Organization

curl --location --request GET 'https://demo.kodjin.com/fhir/fhir-base-url' \
--header 'Content-Type: application/json' \
--data '{
            "resourceType": "Bundle",
            "id": "example-endpoints-r4",
            "type": "collection",
            "entry": [
                {
                    "fullUrl": "https://demo.kodjin.com/fhir/Endpoint/example-endpoint-1",
                    "resource": {
                        "resourceType": "Endpoint",
                        "id": "example-endpoint-1",
                        "name": "Example Endpoint 1",
                        "status": "active",
                        "connectionType": {
                            "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
                            "code": "direct-project"
                        },
                        "payloadType": [
                            {
                                "coding": [
                                    {
                                        "system": "http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode",
                                        "code": "urn:hl7-org:sdwg:ccda-structuredBody:1.1"
                                    }
                                ]
                            }
                        ],
                        "address": "https://demo.kodjin.com/fhir/metadata"
                    }
                },
                {
                    "fullUrl": "https://demo.kodjin.com/fhir/Organization/example-organization-1",
                    "resource": {
                        "resourceType": "Organization",
                        "id": "example-organization-1",
                        "name": "Test Medical Center 1",
                        "active": true,
                        "identifier": [
                            {
                                "system": "http://hl7.org/fhir/sid/us-npi",
                                "value": "1407071236"
                            }
                        ],
                        "address": [
                            {
                                "line": [
                                    "5414 Hilpert Pines"
                                ],
                                "city": "Abbigailburgh",
                                "state": "MA",
                                "postalCode": "43926-0428",
                                "country": "United States of America"
                            }
                        ],
                        "endpoint": [
                            {
                                "reference": "Endpoint/example-endpoint-1"
                            }
                        ]
                    }
                }
            ]
        }'