Generated Narrative: CapabilityStatement organization 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 Conformance Operation Documentation 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 Type Profile R V-R S U P C D Searches _include _revinclude Operations Binary http://hl7.org/fhir/StructureDefinition/Binary y y * 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 CareTeam http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careteam y y y y y y _content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, category, context, context-type, context-type-value, date, encounter, identifier, managingOrganization, participant, patient, reasonCode, status, subject CareTeam:managingOrganization, CareTeam:participant, CareTeam:subject 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 OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * 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 Organization http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-organization y y y y y y _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, type Organization:partof CareTeam:managingOrganization, Organization:partof, Provenance:target $validate, $get-general-practitioner-info, $traverse-to-sor Practitioner http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner y y y y y y _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 PractitionerRole http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitionerrole y y y y y y _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:service 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 Provenance http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance y y y _id, recorded, target 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 Resource Conformance: supported Binary Base System Profile Binary Profile Conformance SHALL Reference Policy Interaction summary Supports vread, read. Resource Conformance: supported CareTeam Base System Profile ehealth-careteam Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, delete, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL category token Type of team SHALL context token A use context assigned to the care team SHALL context-type token A type of use context assigned to the care team SHALL context-type-value composite A use context type and value assigned to the care team SHALL date date Time period team covers SHALL encounter reference Encounter or episode associated with CareTeam SHALL identifier token External Ids for this team SHALL managingOrganization reference Managing organization of a care team SHALL participant reference Who is involved SHALL patient reference Who care team is for SHALL reasonCode token Reason care team exists SHALL status token proposed | active | suspended | inactive | entered-in-error SHALL subject reference Who care team is for Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: supported OperationDefinition Base System Profile OperationDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports read. Resource Conformance: supported Organization Base System Profile ehealth-organization Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, patch, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL active token A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text SHALL address string A (part of the) address of the organization SHALL address-city string A city specified in an address SHALL address-country string A country specified in an address SHALL address-postalcode string A postal code specified in an address SHALL address-state string A state specified in an address SHALL address-use token A use code specified in an address SHALL contactName string Contact name SHALL cvrNumber string Cvr number of the organization SHALL endpoint reference Technical endpoints providing access to services operated for the organization SHALL identifier token Any identifier for the organization (not the accreditation issuer's identifier) SHALL municipalityCode string Municipality code of the organization SHALL name string A portion of the organization's name or alias SHALL partof reference An organization of which this organization forms a part SHALL phonetic string A portion of the organization's name using some kind of phonetic matching algorithm SHALL providerIdentifier string Provider identifier of the organization SHALL regionCode string Region code of the organization SHALL source token Source of the organization SHALL specialty token Specialty of the organization SHALL type token A code for the type of organization Extended Operations Conformance Operation Documentation 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 Resource Conformance: supported Practitioner Base System Profile ehealth-practitioner Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, delete, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL active token Whether the practitioner record is active SHALL address string A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text SHALL address-city string A city specified in an address SHALL address-country string A country specified in an address SHALL address-postalcode string A postalCode specified in an address SHALL address-state string A state specified in an address SHALL address-use token A use code specified in an address SHALL communication token One of the languages that the practitioner can communicate with SHALL email token A value in an email contact SHALL family string A portion of the family name SHALL gender token Gender of the practitioner SHALL given string A portion of the given name SHALL identifier token A practitioner's Identifier SHALL name string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text SHALL phone token A value in a phone contact SHALL phonetic string A portion of either family or given name using some kind of phonetic matching algorithm SHALL telecom token The value in any kind of contact Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: supported PractitionerRole Base System Profile ehealth-practitionerrole Profile Conformance SHALL Reference Policy Interaction summary Supports update, search-type, vread, read, delete, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _has string Return resources linked to by the given target SHALL _id token The ID of the resource SHALL _language string The language of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _profile uri Search for resources which have the given profile SHALL _security token Search for resources which have the given security labels SHALL _tag token Search for resources which have the given tag SHALL _text string Search the contents of the resource's narrative using a fulltext search SHALL active token Whether this practitioner's record is in active use SHALL date date The period during which the practitioner is authorized to perform in these role(s) SHALL email token A value in an email contact SHALL endpoint reference Technical endpoints providing access to services operated for the practitioner with this role SHALL identifier token A practitioner's Identifier SHALL location reference One of the locations at which this practitioner provides care SHALL organization reference The identity of the organization the practitioner represents / acts on behalf of SHALL phone token A value in a phone contact SHALL practitioner reference Practitioner that is able to provide the defined services for the organation SHALL role token The practitioner can perform this role at for the organization SHALL service reference The list of healthcare services that this worker provides for this role's Organization/Location(s) SHALL specialty token The practitioner has this specialty at an organization SHALL telecom token The value in any kind of contact Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: supported Provenance Base System Profile ehealth-provenance Profile Conformance SHALL Reference Policy Interaction summary Supports search-type, vread, read. Search Parameters Conformance Parameter Type Documentation SHALL _id token The ID of the resource SHALL recorded date When the activity was recorded / updated SHALL target reference Target Reference(s) (usually version specific)
Den telemedicinske infrastruktur (eHealth Infrastructure)
Search the contents of the resource's data using a fulltext search
Return resources linked to by the given target
Only return resources which were last updated as specified by the given range
Search for resources which have the given profile
Search for resources which have the given security labels
Search for resources which have the given tag
Search the contents of the resource's narrative using a fulltext search
A type of use context assigned to the care team
A use context type and value assigned to the care team
Encounter or episode associated with CareTeam
proposed | active | suspended | inactive | entered-in-error
A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
A (part of the) address of the organization
Technical endpoints providing access to services operated for the organization
Any identifier for the organization (not the accreditation issuer's identifier)
A portion of the organization's name or alias
An organization of which this organization forms a part
A portion of the organization's name using some kind of phonetic matching algorithm
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.
Traverse upforwards to the first SOR organization Http response code 404 will be returned if no related SOR organization could be found
Whether the practitioner record is active
One of the languages that the practitioner can communicate with
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
A portion of either family or given name using some kind of phonetic matching algorithm
Whether this practitioner's record is in active use
The period during which the practitioner is authorized to perform in these role(s)
Technical endpoints providing access to services operated for the practitioner with this role
One of the locations at which this practitioner provides care
The identity of the organization the practitioner represents / acts on behalf of
Practitioner that is able to provide the defined services for the organation
The practitioner can perform this role at for the organization
The list of healthcare services that this worker provides for this role's Organization/Location(s)
The practitioner has this specialty at an organization
When the activity was recorded / updated
Target Reference(s) (usually version specific)
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.
Import a bundle containing at least one organization tree.
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
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](http://hl7.org/fhir/R4/async.html). ## 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.
Provides the number of resources currently stored on the server, broken down by resource type