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: Mon Apr 29 02:37:33 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 Searches _include _revinclude Operations 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, date, encounter, identifier, managingOrganization, participant, patient, reasonCode, status, subject CareTeam:managingOrganization, CareTeam:participant, CareTeam:subject CareTeam:context, 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 OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * CareTeam:context, 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 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:context, 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 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:context, 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 Provenance http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance y y y _id, recorded, target CareTeam:context, 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: supportedCareTeam Base System Profile http://ehealth.sundhed.dk/fhir/StructureDefinition/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 reference Encounter or episode associated with CareTeam 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: supportedOperationDefinition Base System Profile http://hl7.org/fhir/StructureDefinition/OperationDefinition Profile Conformance SHALL Reference Policy Interaction summary Supports read. Resource Conformance: supportedOrganization Base System Profile http://ehealth.sundhed.dk/fhir/StructureDefinition/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 $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: supportedPractitioner Base System Profile http://ehealth.sundhed.dk/fhir/StructureDefinition/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: supportedPractitionerRole Base System Profile http://ehealth.sundhed.dk/fhir/StructureDefinition/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: supportedProvenance Base System Profile http://ehealth.sundhed.dk/fhir/StructureDefinition/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
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
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.
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