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: Sun Apr 28 18:26:53 UTC 2024 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 transaction interaction. Supports the history-system interaction. 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 H-I H-T Searches _include _revinclude Operations CodeSystem http://hl7.org/fhir/StructureDefinition/CodeSystem y y y y y y y y y _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:supplements CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member ConceptMap http://hl7.org/fhir/StructureDefinition/ConceptMap y y y y y y y y y _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-uri CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member Group http://hl7.org/fhir/StructureDefinition/Group y y y y y y y y y _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:member CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member NamingSystem http://hl7.org/fhir/StructureDefinition/NamingSystem y y y y y y y y y _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 OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member Practitioner http://hl7.org/fhir/StructureDefinition/Practitioner y y y y y y y y y _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 StructureDefinition http://hl7.org/fhir/StructureDefinition/StructureDefinition y y type * CodeSystem:supplements, ConceptMap:other, ConceptMap:source, ConceptMap:source-uri, ConceptMap:target, ConceptMap:target-uri, Group:managing-entity, Group:member ValueSet http://hl7.org/fhir/StructureDefinition/ValueSet y y y y y y y y y _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: supportedCodeSystem Base System Profile http://hl7.org/fhir/StructureDefinition/CodeSystem Profile Conformance SHALL Reference Policy Interaction summary Supports update, vread, read, patch, history-type, history-instance, delete, create, search-type. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter SHALL _has string Return resources linked to by the given target SHALL _id token The ID 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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 code token A code defined in the code system SHALL content-mode token not-present | example | fragment | complete | supplement SHALL context token A use context assigned to the code system SHALL context-quantity quantity A quantity- or range-valued use context assigned to the code system SHALL context-type token A type of use context assigned to the code system SHALL context-type-quantity composite A use context type and quantity- or range-based value assigned to the code system SHALL context-type-value composite A use context type and value assigned to the code system SHALL date date The code system publication date SHALL description string The description of the code system SHALL identifier token External identifier for the code system SHALL jurisdiction token Intended jurisdiction for the code system SHALL language token A language in which a designation is provided SHALL name string Computationally friendly name of the code system SHALL publisher string Name of the publisher of the code system SHALL status token The current status of the code system SHALL supplements reference Find code system supplements for the referenced code system SHALL system uri The system for any codes defined by this code system (same as 'url') SHALL title string The human-friendly name of the code system SHALL url uri The uri that identifies the code system SHALL version token The business version of the code system Extended Operations Conformance Operation Documentation 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: supportedConceptMap Base System Profile http://hl7.org/fhir/StructureDefinition/ConceptMap Profile Conformance SHALL Reference Policy Interaction summary Supports update, vread, read, patch, history-type, history-instance, delete, create, search-type. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter SHALL _has string Return resources linked to by the given target SHALL _id token The ID 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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 context token A use context assigned to the concept map SHALL context-quantity quantity A quantity- or range-valued use context assigned to the concept map SHALL context-type token A type of use context assigned to the concept map SHALL context-type-quantity composite A use context type and quantity- or range-based value assigned to the concept map SHALL context-type-value composite A use context type and value assigned to the concept map SHALL date date The concept map publication date SHALL dependson uri Reference to property mapping depends on SHALL description string The description of the concept map SHALL identifier token External identifier for the concept map SHALL jurisdiction token Intended jurisdiction for the concept map SHALL name string Computationally friendly name of the concept map SHALL other reference canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped SHALL product uri Reference to property mapping depends on SHALL publisher string Name of the publisher of the concept map SHALL source reference The source value set that contains the concepts that are being mapped SHALL source-code token Identifies element being mapped SHALL source-system uri Source system where concepts to be mapped are defined SHALL source-uri reference The source value set that contains the concepts that are being mapped SHALL status token The current status of the concept map SHALL target reference The target value set which provides context for the mappings SHALL target-code token Code that identifies the target element SHALL target-system uri Target system that the concepts are to be mapped to SHALL target-uri reference The target value set which provides context for the mappings SHALL title string The human-friendly name of the concept map SHALL url uri The uri that identifies the concept map SHALL version token The business version of the concept map Extended Operations Conformance Operation Documentation 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: supportedGroup Base System Profile http://hl7.org/fhir/StructureDefinition/Group Profile Conformance SHALL Reference Policy Interaction summary Supports search-type, update, vread, read, patch, history-type, history-instance, delete, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter SHALL _has string Return resources linked to by the given target SHALL _id token The ID 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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 actual token Descriptive or actual SHALL characteristic token Kind of characteristic SHALL characteristic-value composite A composite of both characteristic and value SHALL code token The kind of resources contained SHALL exclude token Group includes or excludes SHALL identifier token Unique id SHALL managing-entity reference Entity that is the custodian of the Group's definition SHALL member reference Reference to the group member SHALL type token The type of resources the group contains SHALL value token Value held by characteristic Extended Operations Conformance Operation Documentation 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: supportedNamingSystem Base System Profile http://hl7.org/fhir/StructureDefinition/NamingSystem Profile Conformance SHALL Reference Policy Interaction summary Supports update, vread, read, patch, history-type, history-instance, delete, create, search-type. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter SHALL _has string Return resources linked to by the given target SHALL _id token The ID 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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 contact string Name of an individual to contact SHALL context token A use context assigned to the naming system SHALL context-quantity quantity A quantity- or range-valued use context assigned to the naming system SHALL context-type token A type of use context assigned to the naming system SHALL context-type-quantity composite A use context type and quantity- or range-based value assigned to the naming system SHALL context-type-value composite A use context type and value assigned to the naming system SHALL date date The naming system publication date SHALL description string The description of the naming system SHALL id-type token oid | uuid | uri | other SHALL jurisdiction token Intended jurisdiction for the naming system SHALL kind token codesystem | identifier | root SHALL name string Computationally friendly name of the naming system SHALL period date When is identifier valid? SHALL publisher string Name of the publisher of the naming system SHALL responsible string Who maintains system namespace? SHALL status token The current status of the naming system SHALL telecom token Contact details for individual or organization SHALL type token e.g. driver, provider, patient, bank etc. SHALL value string The unique identifier Extended Operations Conformance Operation Documentation 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: supportedOperationDefinition Base System Profile http://hl7.org/fhir/StructureDefinition/OperationDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports read. Resource Conformance: supportedPractitioner Base System Profile http://hl7.org/fhir/StructureDefinition/Practitioner Profile Conformance SHALL Reference Policy Interaction summary Supports search-type, update, vread, read, patch, history-type, history-instance, delete, create. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter SHALL _has string Return resources linked to by the given target SHALL _id token The ID 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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, district, 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 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: supportedStructureDefinition Base System Profile http://hl7.org/fhir/StructureDefinition/StructureDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports search-type, read. Search Parameters Conformance Parameter Type Documentation SHALL type token Type defined or constrained by this structure Resource Conformance: supportedValueSet Base System Profile http://hl7.org/fhir/StructureDefinition/ValueSet Profile Conformance SHALL Reference Policy Interaction summary Supports update, vread, read, patch, history-type, history-instance, delete, create, search-type. Search Parameters Conformance Parameter Type Documentation SHALL _content string Search the contents of the resource's data using a fulltext search SHALL _filter string Search the contents of the resource's data using a filter SHALL _has string Return resources linked to by the given target SHALL _id token The ID 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 _source uri Search for resources which have the given source value (Resource.meta.source) 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 code token This special parameter searches for codes in the value set. See additional notes on the ValueSet resource SHALL context token A use context assigned to the value set SHALL context-quantity quantity A quantity- or range-valued use context assigned to the value set SHALL context-type token A type of use context assigned to the value set SHALL context-type-quantity composite A use context type and quantity- or range-based value assigned to the value set SHALL context-type-value composite A use context type and value assigned to the value set SHALL date date The value set publication date SHALL description string The description of the value set SHALL expansion uri Identifies the value set expansion (business identifier) SHALL identifier token External identifier for the value set SHALL jurisdiction token Intended jurisdiction for the value set SHALL name string Computationally friendly name of the value set SHALL publisher string Name of the publisher of the value set SHALL reference uri A code system included or excluded in the value set or an imported value set SHALL status token The current status of the value set SHALL title string The human-friendly name of the value set SHALL url uri The uri that identifies the value set SHALL version token The business version of the value set Extended Operations Conformance Operation Documentation 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
Den telemedicinske infrastruktur (eHealth Infrastructure)
Search the contents of the resource's data using a fulltext search
Search the contents of the resource's data using a filter
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 source value (Resource.meta.source)
Search for resources which have the given tag
Search the contents of the resource's narrative using a fulltext search
not-present | example | fragment | complete | supplement
A use context assigned to the code system
A quantity- or range-valued use context assigned to the code system
A type of use context assigned to the code system
A use context type and quantity- or range-based value assigned to the code system
A use context type and value assigned to the code system
Intended jurisdiction for the code system
A language in which a designation is provided
Computationally friendly name of the code system
Name of the publisher of the code system
Find code system supplements for the referenced code system
The system for any codes defined by this code system (same as 'url')
The human-friendly name of the code system
Delete tags, profiles, and/or security labels from a resource
Add tags, profiles, and/or security labels to a resource
Request a list of tags, profiles, and security labels for a specfic resource instance
A use context assigned to the concept map
A quantity- or range-valued use context assigned to the concept map
A type of use context assigned to the concept map
A use context type and quantity- or range-based value assigned to the concept map
A use context type and value assigned to the concept map
Reference to property mapping depends on
Intended jurisdiction for the concept map
Computationally friendly name of the concept map
canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
Name of the publisher of the concept map
The source value set that contains the concepts that are being mapped
Source system where concepts to be mapped are defined
The target value set which provides context for the mappings
Target system that the concepts are to be mapped to
The human-friendly name of the concept map
A composite of both characteristic and value
Entity that is the custodian of the Group's definition
The type of resources the group contains
A use context assigned to the naming system
A quantity- or range-valued use context assigned to the naming system
A type of use context assigned to the naming system
A use context type and quantity- or range-based value assigned to the naming system
A use context type and value assigned to the naming system
Intended jurisdiction for the naming system
Computationally friendly name of the naming system
Name of the publisher of the naming system
Contact details for individual or organization
e.g. driver, provider, patient, bank etc.
Whether the practitioner record is active
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
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
Type defined or constrained by this structure
This special parameter searches for codes in the value set. See additional notes on the ValueSet resource
A quantity- or range-valued use context assigned to the value set
A type of use context assigned to the value set
A use context type and quantity- or range-based value assigned to the value set
A use context type and value assigned to the value set
Identifies the value set expansion (business identifier)
Computationally friendly name of the value set
A code system included or excluded in the value set or an imported value set
The human-friendly name of the value set
Accept a FHIR Message Bundle for processing
Forces a single pass of the resource reindexing processor
Provides the number of resources currently stored on the server, broken down by resource type