eHealth Infrastructure
3.1.0 - release

This page is part of the FUT Infrastructure (v3.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: terminology

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/terminology Version: 3.1.0
Active as of 2024-04-28 Computable Name: terminology

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement terminology

  • Implementation Guide Version: 3.1.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
  • Supported Patch Formats:
  • Published on: 2024-04-28 18:26:53+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.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the history-systeminteraction.

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-RSUPCDH-IH-TSearches_include_revincludeOperations
CodeSystemhttp://hl7.org/fhir/StructureDefinition/CodeSystemyyyyyyyyy_content, _filter, _has, _id, _lastUpdated, _profile, _security, _source, _tag, _text, code, content-mode, context, context-quantity, context-type, context-type-quantity, context-type-value, date, description, identifier, jurisdiction, language, name, publisher, status, supplements, system, title, url, version*, CodeSystem:supplementsCodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
ConceptMaphttp://hl7.org/fhir/StructureDefinition/ConceptMapyyyyyyyyy_content, _filter, _has, _id, _lastUpdated, _profile, _security, _source, _tag, _text, context, context-quantity, context-type, context-type-quantity, context-type-value, date, dependson, description, identifier, jurisdiction, name, other, product, publisher, source, source-code, source-system, source-uri, status, target, target-code, target-system, target-uri, title, url, version*, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uriCodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
Grouphttp://hl7.org/fhir/StructureDefinition/Groupyyyyyyyyy_content, _filter, _has, _id, _lastUpdated, _profile, _security, _source, _tag, _text, actual, characteristic, characteristic-value, code, exclude, identifier, managing-entity, member, type, value*, Group:managing-entity, Group:memberCodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
NamingSystemhttp://hl7.org/fhir/StructureDefinition/NamingSystemyyyyyyyyy_content, _filter, _has, _id, _lastUpdated, _profile, _security, _source, _tag, _text, contact, context, context-quantity, context-type, context-type-quantity, context-type-value, date, description, id-type, jurisdiction, kind, name, period, publisher, responsible, status, telecom, type, value*CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioneryyyyyyyyy_content, _filter, _has, _id, _lastUpdated, _profile, _security, _source, _tag, _text, active, address, address-city, address-country, address-postalcode, address-state, address-use, communication, email, family, gender, given, identifier, name, phone, phonetic, telecom*CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinitionyytype*CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSetyyyyyyyyy_content, _filter, _has, _id, _lastUpdated, _profile, _security, _source, _tag, _text, code, context, context-quantity, context-type, context-type-quantity, context-type-value, date, description, expansion, identifier, jurisdiction, name, publisher, reference, status, title, url, version*CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member

Resource Conformance: supported CodeSystem

Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

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

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID 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_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

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

SHALLcodetoken

A code defined in the code system

SHALLcontent-modetoken

not-present | example | fragment | complete | supplement

SHALLcontexttoken

A use context assigned to the code system

SHALLcontext-quantityquantity

A quantity- or range-valued use context assigned to the code system

SHALLcontext-typetoken

A type of use context assigned to the code system

SHALLcontext-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the code system

SHALLcontext-type-valuecomposite

A use context type and value assigned to the code system

SHALLdatedate

The code system publication date

SHALLdescriptionstring

The description of the code system

SHALLidentifiertoken

External identifier for the code system

SHALLjurisdictiontoken

Intended jurisdiction for the code system

SHALLlanguagetoken

A language in which a designation is provided

SHALLnamestring

Computationally friendly name of the code system

SHALLpublisherstring

Name of the publisher of the code system

SHALLstatustoken

The current status of the code system

SHALLsupplementsreference

Find code system supplements for the referenced code system

SHALLsystemuri

The system for any codes defined by this code system (same as 'url')

SHALLtitlestring

The human-friendly name of the code system

SHALLurluri

The uri that identifies the code system

SHALLversiontoken

The business version of the code system

 
Extended Operations
ConformanceOperationDocumentation
SHALL$upload-external-code-system
SHALL$apply-codesystem-delta-remove
SHALL$apply-codesystem-delta-add
SHALL$validate
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge
SHALL$validate-code
SHALL$subsumes
SHALL$lookup

Resource Conformance: supported ConceptMap

Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

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

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID 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_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

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

SHALLcontexttoken

A use context assigned to the concept map

SHALLcontext-quantityquantity

A quantity- or range-valued use context assigned to the concept map

SHALLcontext-typetoken

A type of use context assigned to the concept map

SHALLcontext-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the concept map

SHALLcontext-type-valuecomposite

A use context type and value assigned to the concept map

SHALLdatedate

The concept map publication date

SHALLdependsonuri

Reference to property mapping depends on

SHALLdescriptionstring

The description of the concept map

SHALLidentifiertoken

External identifier for the concept map

SHALLjurisdictiontoken

Intended jurisdiction for the concept map

SHALLnamestring

Computationally friendly name of the concept map

SHALLotherreference

canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

SHALLproducturi

Reference to property mapping depends on

SHALLpublisherstring

Name of the publisher of the concept map

SHALLsourcereference

The source value set that contains the concepts that are being mapped

SHALLsource-codetoken

Identifies element being mapped

SHALLsource-systemuri

Source system where concepts to be mapped are defined

SHALLsource-urireference

The source value set that contains the concepts that are being mapped

SHALLstatustoken

The current status of the concept map

SHALLtargetreference

The target value set which provides context for the mappings

SHALLtarget-codetoken

Code that identifies the target element

SHALLtarget-systemuri

Target system that the concepts are to be mapped to

SHALLtarget-urireference

The target value set which provides context for the mappings

SHALLtitlestring

The human-friendly name of the concept map

SHALLurluri

The uri that identifies the concept map

SHALLversiontoken

The business version of the concept map

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge
SHALL$translate

Resource Conformance: supported Group

Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

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

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID 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_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

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

SHALLactualtoken

Descriptive or actual

SHALLcharacteristictoken

Kind of characteristic

SHALLcharacteristic-valuecomposite

A composite of both characteristic and value

SHALLcodetoken

The kind of resources contained

SHALLexcludetoken

Group includes or excludes

SHALLidentifiertoken

Unique id

SHALLmanaging-entityreference

Entity that is the custodian of the Group's definition

SHALLmemberreference

Reference to the group member

SHALLtypetoken

The type of resources the group contains

SHALLvaluetoken

Value held by characteristic

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge

Resource Conformance: supported NamingSystem

Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

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

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID 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_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

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

SHALLcontactstring

Name of an individual to contact

SHALLcontexttoken

A use context assigned to the naming system

SHALLcontext-quantityquantity

A quantity- or range-valued use context assigned to the naming system

SHALLcontext-typetoken

A type of use context assigned to the naming system

SHALLcontext-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the naming system

SHALLcontext-type-valuecomposite

A use context type and value assigned to the naming system

SHALLdatedate

The naming system publication date

SHALLdescriptionstring

The description of the naming system

SHALLid-typetoken

oid | uuid | uri | other

SHALLjurisdictiontoken

Intended jurisdiction for the naming system

SHALLkindtoken

codesystem | identifier | root

SHALLnamestring

Computationally friendly name of the naming system

SHALLperioddate

When is identifier valid?

SHALLpublisherstring

Name of the publisher of the naming system

SHALLresponsiblestring

Who maintains system namespace?

SHALLstatustoken

The current status of the naming system

SHALLtelecomtoken

Contact details for individual or organization

SHALLtypetoken

e.g. driver, provider, patient, bank etc.

SHALLvaluestring

The unique identifier

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge

Resource Conformance: supported OperationDefinition

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported Practitioner

Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

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

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID 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_sourceuri

Search for resources which have the given source value (Resource.meta.source)

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, district, 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
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge

Resource Conformance: supported StructureDefinition

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtypetoken

Type defined or constrained by this structure

 

Resource Conformance: supported ValueSet

Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

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

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID 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_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

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

SHALLcodetoken

This special parameter searches for codes in the value set. See additional notes on the ValueSet resource

SHALLcontexttoken

A use context assigned to the value set

SHALLcontext-quantityquantity

A quantity- or range-valued use context assigned to the value set

SHALLcontext-typetoken

A type of use context assigned to the value set

SHALLcontext-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the value set

SHALLcontext-type-valuecomposite

A use context type and value assigned to the value set

SHALLdatedate

The value set publication date

SHALLdescriptionstring

The description of the value set

SHALLexpansionuri

Identifies the value set expansion (business identifier)

SHALLidentifiertoken

External identifier for the value set

SHALLjurisdictiontoken

Intended jurisdiction for the value set

SHALLnamestring

Computationally friendly name of the value set

SHALLpublisherstring

Name of the publisher of the value set

SHALLreferenceuri

A code system included or excluded in the value set or an imported value set

SHALLstatustoken

The current status of the value set

SHALLtitlestring

The human-friendly name of the value set

SHALLurluri

The uri that identifies the value set

SHALLversiontoken

The business version of the value set

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate-code
SHALL$invalidate-expansion
SHALL$expand
SHALL$validate
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge