eHealth Infrastructure
8.0.0 - release Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 8.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions

CapabilityStatement: organization

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/organization Version: 8.0.0
Active as of 2025-12-09 Computable Name: organization

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 8.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl, html/json, html/xml, html/turtle
  • Published on: 2025-12-09 02:37:12+0000
  • Published by: Den telemedicinske infrastruktur (eHealth Infrastructure)

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

This CapabilityStatement instantiates the CapabilityStatement http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Operations
ConformanceOperationDocumentation
SHALL$reindex
SHALL$persist-login

This operation persists login information into CareTeams and PractitionerRoles The following elements of each careteam are mandatory:

  • id: Reference based on the careteam from the saml security token
  • status: any
  • name: any
  • reasonCode: any
  • participant: 1 for each careteam-role in the saml security token -- role: from the saml security token -- member: reference to the practitioner -- onBehalfOf: reference to organization (cannot be set currently because of a bug in hapi)

Persist-login will find each careteam, and update it with any new participants and roles from the input bundle. The input careteam resources are are used as a container for the participant list. The rest of the fields are not used. The following elements of each PractitionerRole are mandatory:

  • practitioner
  • organization
  • code: roles from the saml security token (CareteamParticipantRole valueset)

Persist-login will search for practitionerRoles for each combination of (practitioner, organization) and create it if it doesn't already exists.

SHALL$import-organizations

Import a bundle containing at least one organization tree.

SHALL$export-poll-status

Operation for polling the status of a previously initiated FHIR Bulk Data System Level Export. A complete URL including the '_jobId' is returned in the 'Content-Location' response header when initiating the export. A 'GET' request to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk data files. A 'DELETE' request can be used to cancel the export. If the export has already finished, the delete will return '404 Not Found', else the export job will be cancelled and a '202 Accepted' is returned with an operation outcome response.

Parameters

  • _jobId: the job ID for the Bulk Export job which was returned in the 'Content-Location' header when initiating the export
SHALL$export

FHIR Operation to initiate an export of data from a FHIR server. The type of resources returned can be restricted using the '_type' parameter, and the '_since' parameter can be used to restrict resources to be only included if changed since the supplied time. The FHIR server support invocation of this operation using the FHIR Asynchronous Request Pattern.

Initiation of export

The initiation of an export must specify the request header 'Prefer: respond-async', and will return '202 Accepted' with a polling location in the response header 'Content-Location'. The polling location is for the endpoint '$export-poll-status' and has the export job ID as parameter '_jobId'.

Parameters

  • _outputFormat: Optional parameter to specify the output format of the exported files. Default is 'application/fhir+ndjson'
  • _type: Optional parameter to specify a comma separated list of resource types to be included in the export. If not provided, all resource types will be included.
  • _since: Optional parameter to specify a time. Only resources that have been created or modified after this time will be included in the export (i.e., if Resource.meta.lastUpdated is later than the supplied _since time).
  • _typePostFetchFilterUrl: Optional parameter to apply filtering of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied on resources after being fetched from the database.
  • _exportId: Optional parameter to specify a client provided identifier for the export. Resulting exported files (Binary) will be labeled with the identifer in meta extension 'https://hapifhir.org/NamingSystem/bulk-export-identifier'

Polling status of export

Subsequent GET requests to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk export data files.

Retrieving exported files

The JSON object returned when the export job is complete will contain a list of files (Binary resources) available for download. Each file can be retrieved using a standard HTTP GET request to the provided URL. The security context of the Binary resources resulting from the export is the user that initiated the export. The files can therefore only be retrieved by the same user.

Retention of exported files

The exported files are retained for a limited time after which they are deleted. The retention time is a server configuration with default 2 hours.

SHALL$meta
SHALL$get-resource-counts

Provides the number of resources currently stored on the server, broken down by resource type

SHALL$expunge

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUPCDSearches_include_revincludeOperations
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryyy*CareTeam:encounter, CareTeam:managingOrganization, CareTeam:participant, CareTeam:patient, CareTeam:subject, Organization:endpoint, Organization:partof, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service, Provenance:target
CareTeamhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteamyyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, category, context, context-type, context-type-value, date, encounter, identifier, managingOrganization, participant, patient, reasonCode, status, subjectCareTeam:managingOrganization, CareTeam:participant, CareTeam:subjectCareTeam:encounter, CareTeam:managingOrganization, CareTeam:participant, CareTeam:patient, CareTeam:subject, Organization:endpoint, Organization:partof, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service, Provenance:target$validate
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*CareTeam:encounter, CareTeam:managingOrganization, CareTeam:participant, CareTeam:patient, CareTeam:subject, Organization:endpoint, Organization:partof, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service, Provenance:target
Organizationhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-organizationyyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, active, address, address-city, address-country, address-postalcode, address-state, address-use, contactName, cvrNumber, endpoint, identifier, municipalityCode, name, partof, phonetic, providerIdentifier, regionCode, source, specialty, typeOrganization:partofCareTeam:managingOrganization, Organization:partof, Provenance:target$validate, $get-general-practitioner-info, $traverse-to-sor
Practitionerhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioneryyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, active, address, address-city, address-country, address-postalcode, address-state, address-use, communication, email, family, gender, given, identifier, name, phone, phonetic, telecom*CareTeam:encounter, CareTeam:managingOrganization, CareTeam:participant, CareTeam:patient, CareTeam:subject, Organization:endpoint, Organization:partof, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service, Provenance:target$validate
PractitionerRolehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitionerroleyyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, active, date, email, endpoint, identifier, location, organization, phone, practitioner, role, service, specialty, telecom*, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:serviceCareTeam:encounter, CareTeam:managingOrganization, CareTeam:participant, CareTeam:patient, CareTeam:subject, Organization:endpoint, Organization:partof, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service, Provenance:target$validate
Provenancehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenanceyyy_id, recorded, targetCareTeam:encounter, CareTeam:managingOrganization, CareTeam:participant, CareTeam:patient, CareTeam:subject, Organization:endpoint, Organization:partof, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service, Provenance:target
Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports vread, read.

Base System Profile
ehealth-careteam
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, delete, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLcategorytoken

Type of team

SHALLcontexttoken

A use context assigned to the care team

SHALLcontext-typetoken

A type of use context assigned to the care team

SHALLcontext-type-valuecomposite

A use context type and value assigned to the care team

SHALLdatedate

Time period team covers

SHALLencounterreference

Encounter or episode associated with CareTeam

SHALLidentifiertoken

External Ids for this team

SHALLmanagingOrganizationreference

Managing organization of a care team

SHALLparticipantreference

Who is involved

SHALLpatientreference

Who care team is for

SHALLreasonCodetoken

Reason care team exists

SHALLstatustoken

proposed | active | suspended | inactive | entered-in-error

SHALLsubjectreference

Who care team is for

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Base System Profile
ehealth-organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, patch, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLactivetoken

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

SHALLaddressstring

A (part of the) address of the organization

SHALLaddress-citystring

A city specified in an address

SHALLaddress-countrystring

A country specified in an address

SHALLaddress-postalcodestring

A postal code specified in an address

SHALLaddress-statestring

A state specified in an address

SHALLaddress-usetoken

A use code specified in an address

SHALLcontactNamestring

Contact name

SHALLcvrNumberstring

Cvr number of the organization

SHALLendpointreference

Technical endpoints providing access to services operated for the organization

SHALLidentifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALLmunicipalityCodestring

Municipality code of the organization

SHALLnamestring

A portion of the organization's name or alias

SHALLpartofreference

An organization of which this organization forms a part

SHALLphoneticstring

A portion of the organization's name using some kind of phonetic matching algorithm

SHALLproviderIdentifierstring

Provider identifier of the organization

SHALLregionCodestring

Region code of the organization

SHALLsourcetoken

Source of the organization

SHALLspecialtytoken

Specialty of the organization

SHALLtypetoken

A code for the type of organization

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$get-general-practitioner-info

The operation resolves the input organization(s) to the shared organization for the one or more organizations that have the given provider number. The Organization returned depends on how many active Organization exist in the service with that provider number. When a single Organization has the provider number that Organization is returned. When multiple Organization resources have the same provider number, the shared parent Organization is returned. An OperationOutcome with an explicit error is returned in case multiple organizations share the provider number but do not have a shared parent, or in case input organizations have different provider numbers. A typical use of the operation is to get name, address and telecom details for a general practitioner. Many provider numbers are assigned to a single organization but some provider numbers are shared by multiple entities (organizations) within in a common practice.

SHALL$traverse-to-sor

Traverse upforwards to the first SOR organization Http response code 404 will be returned if no related SOR organization could be found

Base System Profile
ehealth-practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, delete, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLactivetoken

Whether the practitioner record is active

SHALLaddressstring

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

SHALLaddress-citystring

A city specified in an address

SHALLaddress-countrystring

A country specified in an address

SHALLaddress-postalcodestring

A postalCode specified in an address

SHALLaddress-statestring

A state specified in an address

SHALLaddress-usetoken

A use code specified in an address

SHALLcommunicationtoken

One of the languages that the practitioner can communicate with

SHALLemailtoken

A value in an email contact

SHALLfamilystring

A portion of the family name

SHALLgendertoken

Gender of the practitioner

SHALLgivenstring

A portion of the given name

SHALLidentifiertoken

A practitioner's Identifier

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALLphonetoken

A value in a phone contact

SHALLphoneticstring

A portion of either family or given name using some kind of phonetic matching algorithm

SHALLtelecomtoken

The value in any kind of contact

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
Base System Profile
ehealth-practitionerrole
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, delete, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLactivetoken

Whether this practitioner's record is in active use

SHALLdatedate

The period during which the practitioner is authorized to perform in these role(s)

SHALLemailtoken

A value in an email contact

SHALLendpointreference

Technical endpoints providing access to services operated for the practitioner with this role

SHALLidentifiertoken

A practitioner's Identifier

SHALLlocationreference

One of the locations at which this practitioner provides care

SHALLorganizationreference

The identity of the organization the practitioner represents / acts on behalf of

SHALLphonetoken

A value in a phone contact

SHALLpractitionerreference

Practitioner that is able to provide the defined services for the organation

SHALLroletoken

The practitioner can perform this role at for the organization

SHALLservicereference

The list of healthcare services that this worker provides for this role's Organization/Location(s)

SHALLspecialtytoken

The practitioner has this specialty at an organization

SHALLtelecomtoken

The value in any kind of contact

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
Base System Profile
ehealth-provenance
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, vread, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

SHALLrecordeddate

When the activity was recorded / updated

SHALLtargetreference

Target Reference(s) (usually version specific)