application/fhir+xml
, xml
, application/fhir+json
, json
, application/x-turtle
, ttl
, html/json
, html/xml
, html/turtle
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.
server
transaction
interaction.history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
ActivityDefinition | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition | y | y | y | y | y | _content, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, base, baseEnvironment, composed-of, context, context-quantity, context-type, date, depends-on, derived-from, description, effective, ehealthPredecessor, employeeTitle, identifier, intendedAudience, jurisdiction, modifier_role_reference, modifier_role_role, name, predecessor, publisher, recommendation, status, successor, title, topic, url, version | ActivityDefinition:composed-of , ActivityDefinition:depends-on , ActivityDefinition:derived-from , ActivityDefinition:predecessor , ActivityDefinition:successor | ActivityDefinition:composed-of , ActivityDefinition:depends-on , ActivityDefinition:derived-from , ActivityDefinition:intendedAudience , ActivityDefinition:modifier_role_reference , ActivityDefinition:predecessor , ActivityDefinition:successor , DocumentReference:authenticator , DocumentReference:author , DocumentReference:custodian , DocumentReference:encounter , DocumentReference:patient , DocumentReference:related , DocumentReference:relatesto , DocumentReference:subject , PlanDefinition:composed-of , PlanDefinition:definition , PlanDefinition:depends-on , PlanDefinition:derived-from , PlanDefinition:documentation , PlanDefinition:intendedAudience , PlanDefinition:modifier_role_reference , PlanDefinition:predecessor , PlanDefinition:successor | |
DocumentReference | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference | y | y | y | y | y | _content, _filter, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, authenticator, author, category, contenttype, custodian, date, description, encounter, event, facility, format, identifier, language, location, patient, period, related, relatesto, relation, relationship, security-label, setting, status, subject, type | * , DocumentReference:authenticator , DocumentReference:author , DocumentReference:custodian , DocumentReference:encounter , DocumentReference:patient , DocumentReference:related , DocumentReference:relatesto , DocumentReference:subject | ActivityDefinition:composed-of , ActivityDefinition:depends-on , ActivityDefinition:derived-from , ActivityDefinition:intendedAudience , ActivityDefinition:modifier_role_reference , ActivityDefinition:predecessor , ActivityDefinition:successor , DocumentReference:authenticator , DocumentReference:author , DocumentReference:custodian , DocumentReference:encounter , DocumentReference:patient , DocumentReference:related , DocumentReference:relatesto , DocumentReference:subject , PlanDefinition:composed-of , PlanDefinition:definition , PlanDefinition:depends-on , PlanDefinition:derived-from , PlanDefinition:documentation , PlanDefinition:intendedAudience , PlanDefinition:modifier_role_reference , PlanDefinition:predecessor , PlanDefinition:successor | |
OperationDefinition | http://hl7.org/fhir/StructureDefinition/OperationDefinition | y | * | ActivityDefinition:composed-of , ActivityDefinition:depends-on , ActivityDefinition:derived-from , ActivityDefinition:intendedAudience , ActivityDefinition:modifier_role_reference , ActivityDefinition:predecessor , ActivityDefinition:successor , DocumentReference:authenticator , DocumentReference:author , DocumentReference:custodian , DocumentReference:encounter , DocumentReference:patient , DocumentReference:related , DocumentReference:relatesto , DocumentReference:subject , PlanDefinition:composed-of , PlanDefinition:definition , PlanDefinition:depends-on , PlanDefinition:derived-from , PlanDefinition:documentation , PlanDefinition:intendedAudience , PlanDefinition:modifier_role_reference , PlanDefinition:predecessor , PlanDefinition:successor | ||||||
PlanDefinition | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition | y | y | y | y | y | _content, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, base, baseEnvironment, composed-of, context, context-quantity, context-type, date, definition, depends-on, derived-from, description, documentation, effective, ehealthPredecessor, employeeTitle, identifier, intendedAudience, jurisdiction, modifier_role_reference, modifier_role_role, name, predecessor, publisher, recommendation, status, successor, title, topic, type, url, version | * , PlanDefinition:composed-of , PlanDefinition:definition , PlanDefinition:depends-on , PlanDefinition:derived-from , PlanDefinition:documentation , PlanDefinition:predecessor , PlanDefinition:successor | ActivityDefinition:composed-of , ActivityDefinition:depends-on , ActivityDefinition:derived-from , ActivityDefinition:intendedAudience , ActivityDefinition:modifier_role_reference , ActivityDefinition:predecessor , ActivityDefinition:successor , DocumentReference:authenticator , DocumentReference:author , DocumentReference:custodian , DocumentReference:encounter , DocumentReference:patient , DocumentReference:related , DocumentReference:relatesto , DocumentReference:subject , PlanDefinition:composed-of , PlanDefinition:definition , PlanDefinition:depends-on , PlanDefinition:derived-from , PlanDefinition:documentation , PlanDefinition:intendedAudience , PlanDefinition:modifier_role_reference , PlanDefinition:predecessor , PlanDefinition:successor |
update
, search-type
, vread
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _content | string | Search the contents of the resource's data using a fulltext search \n |
SHALL | _has | string | Return resources linked to by the given target \n |
SHALL | _id | token | The ID of the resource \n |
SHALL | _language | string | The language of the resource \n |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range \n |
SHALL | _profile | uri | Search for resources which have the given profile \n |
SHALL | _security | token | Search for resources which have the given security labels \n |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) \n |
SHALL | _tag | token | Search for resources which have the given tag \n |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search \n |
SHALL | base | token | Base of resource \n |
SHALL | baseEnvironment | token | Base Environment of resource \n |
SHALL | composed-of | reference | What resource is being referenced \n |
SHALL | context | token | A use context assigned to the activity definition \n |
SHALL | context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition \n |
SHALL | context-type | token | A type of use context assigned to the activity definition \n |
SHALL | date | date | The activity definition publication date \n |
SHALL | depends-on | reference | What resource is being referenced \n |
SHALL | derived-from | reference | What resource is being referenced \n |
SHALL | description | string | The description of the activity definition \n |
SHALL | effective | date | The time during which the activity definition is intended to be in use \n |
SHALL | ehealthPredecessor | token | Predecessor of resource \n |
SHALL | employeeTitle | string | Title intented for clinicians \n |
SHALL | identifier | token | External identifier for the activity definition \n |
SHALL | intendedAudience | reference | The intended audience of the plan definition \n |
SHALL | jurisdiction | token | Intended jurisdiction for the activity definition \n |
SHALL | modifier_role_reference | reference | Reference to either Organization, CareTeam, Practitioner \n |
SHALL | modifier_role_role | token | Role of Organization, CareTeam, Practitioner \n |
SHALL | name | string | Computationally friendly name of the activity definition \n |
SHALL | predecessor | reference | What resource is being referenced \n |
SHALL | publisher | string | Name of the publisher of the activity definition \n |
SHALL | recommendation | token | Recommendation for the plan definition \n |
SHALL | status | token | The current status of the activity definition \n |
SHALL | successor | reference | What resource is being referenced \n |
SHALL | title | string | The human-friendly name of the activity definition \n |
SHALL | topic | token | Topics associated with the module \n |
SHALL | url | uri | The uri that identifies the activity definition \n |
SHALL | version | token | The business version of the activity definition \n |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $create-clone | Input\n
Output\nBundle containing all resources that were created during the operation. \nValidation\n
|
update
, search-type
, vread
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _content | string | Search the contents of the resource's data using a fulltext search \n |
SHALL | _filter | string | Search the contents of the resource's data using a filter \n |
SHALL | _has | string | Return resources linked to by the given target \n |
SHALL | _id | token | The ID of the resource \n |
SHALL | _language | string | The language of the resource \n |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range \n |
SHALL | _profile | uri | Search for resources which have the given profile \n |
SHALL | _security | token | Search for resources which have the given security labels \n |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) \n |
SHALL | _tag | token | Search for resources which have the given tag \n |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search \n |
SHALL | authenticator | reference | Who/what authenticated the document \n |
SHALL | author | reference | Who and/or what authored the document \n |
SHALL | category | token | Categorization of document \n |
SHALL | contenttype | token | Mime type of the content, with charset etc. \n |
SHALL | custodian | reference | Organization which maintains the document \n |
SHALL | date | date | When this document reference was created \n |
SHALL | description | string | Human-readable description \n |
SHALL | encounter | reference | Context of the document content \n |
SHALL | event | token | Main clinical acts documented \n |
SHALL | facility | token | Kind of facility where patient was seen \n |
SHALL | format | token | Format/content rules for the document \n |
SHALL | identifier | token | Master Version Specific Identifier \n |
SHALL | language | token | Human language of the content (BCP-47) \n |
SHALL | location | uri | Uri where the data can be found \n |
SHALL | patient | reference | Who/what is the subject of the document \n |
SHALL | period | date | Time of service that is being documented \n |
SHALL | related | reference | Related identifiers or resources \n |
SHALL | relatesto | reference | Target of the relationship \n |
SHALL | relation | token | replaces | transforms | signs | appends \n |
SHALL | relationship | composite | Combination of relation and relatesTo \n |
SHALL | security-label | token | Document security-tags \n |
SHALL | setting | token | Additional details about where the content was created (e.g. clinical specialty) \n |
SHALL | status | token | current | superseded | entered-in-error \n |
SHALL | subject | reference | Who/what is the subject of the document \n |
SHALL | type | token | Kind of document (LOINC if possible) \n |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate |
read
.update
, search-type
, vread
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _content | string | Search the contents of the resource's data using a fulltext search \n |
SHALL | _has | string | Return resources linked to by the given target \n |
SHALL | _id | token | The ID of the resource \n |
SHALL | _language | string | The language of the resource \n |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range \n |
SHALL | _profile | uri | Search for resources which have the given profile \n |
SHALL | _security | token | Search for resources which have the given security labels \n |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) \n |
SHALL | _tag | token | Search for resources which have the given tag \n |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search \n |
SHALL | base | token | Base of resource \n |
SHALL | baseEnvironment | token | Base Environment of resource \n |
SHALL | composed-of | reference | What resource is being referenced \n |
SHALL | context | token | A use context assigned to the plan definition \n |
SHALL | context-quantity | quantity | A quantity- or range-valued use context assigned to the plan definition \n |
SHALL | context-type | token | A type of use context assigned to the plan definition \n |
SHALL | date | date | The plan definition publication date \n |
SHALL | definition | reference | Activity or plan definitions used by plan definition \n |
SHALL | depends-on | reference | What resource is being referenced \n |
SHALL | derived-from | reference | What resource is being referenced \n |
SHALL | description | string | The description of the plan definition \n |
SHALL | documentation | reference | What resource is being referenced \n |
SHALL | effective | date | The time during which the plan definition is intended to be in use \n |
SHALL | ehealthPredecessor | token | Predecessor of resource \n |
SHALL | employeeTitle | string | Title intented for clinicians \n |
SHALL | identifier | token | External identifier for the plan definition \n |
SHALL | intendedAudience | reference | The intended audience of the plan definition \n |
SHALL | jurisdiction | token | Intended jurisdiction for the plan definition \n |
SHALL | modifier_role_reference | reference | Reference to either Organization, CareTeam, Practitioner \n |
SHALL | modifier_role_role | token | Role of Organization, CareTeam, Practitioner \n |
SHALL | name | string | Computationally friendly name of the plan definition \n |
SHALL | predecessor | reference | What resource is being referenced \n |
SHALL | publisher | string | Name of the publisher of the plan definition \n |
SHALL | recommendation | token | Recommendation for the plan definition \n |
SHALL | status | token | The current status of the plan definition \n |
SHALL | successor | reference | What resource is being referenced \n |
SHALL | title | string | The human-friendly name of the plan definition \n |
SHALL | topic | token | Topics associated with the module \n |
SHALL | type | token | The type of artifact the plan (e.g. order-set, eca-rule, protocol) \n |
SHALL | url | uri | The uri that identifies the plan definition \n |
SHALL | version | token | The business version of the plan definition \n |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $import | Import a Plandefinition \nParameters\n
Output\nBundle containing the created resources. PlanDefinitions, ActivityDefinitions, and Questionnaires will be created. Imports QFFD DocumentReference into Document-Transformation service.Libraries and Organizations are used to find the corresponding resources on the target system. \n |
SHALL | $export | Export a PlanDefinition. \nExport Contents\nThe export contains the PlanDefinition including referenced resources:- PlanDefinitions \n
Each resource is returned in a separate JSon file. \nParameters\n
Output\nOutput can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.\nAll returned objects are Fhir resources. See the implementation guide for details \n |
SHALL | $create-clone | Input\n
Output\nBundle containing all resources that were created during the operation. \nValidation\n
|
SHALL | $apply | Create a careplan for a specific episodeOfCare using this PlanDefinition as a template. \n |