Data Sharing Framework (DSF) Implementation Guide
2.0.0 - ci-build
Data Sharing Framework (DSF) Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://dsf.dev/fhir/CapabilityStatement/dsf | Version: | |||
Active as of 2025-03-24 | Computable Name: |
Raw OpenAPI-Swagger Definition file | Download
application/fhir+json
, application/fhir+xml
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
Certificates
, OAuth
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 | D | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|
ActivityDefinition | http://hl7.org/fhir/StructureDefinition/ActivityDefinition Additional supported profiles: DSF ActivityDefinition | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version | |||
Binary | http://hl7.org/fhir/StructureDefinition/Binary | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, contentType | |||
Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier | |||
CodeSystem | http://hl7.org/fhir/StructureDefinition/CodeSystem Additional supported profiles: CodeSystem | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version | |||
DocumentReference | http://hl7.org/fhir/StructureDefinition/DocumentReference | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier | |||
Endpoint | http://hl7.org/fhir/StructureDefinition/Endpoint Additional supported profiles: DSF Endpoint | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _revinclude, _since, _sort, _summary, address, identifier, name, organization, status | Endpoint:organization:Organization | Organization:endpoint:Endpoint | |
Group | http://hl7.org/fhir/StructureDefinition/Group | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _revinclude, _since, _sort, _summary, identifier | ResearchStudy:enrollment:Group | ||
HealthcareService | http://hl7.org/fhir/StructureDefinition/HealthcareService | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier, name | |||
Library | http://hl7.org/fhir/StructureDefinition/Library Additional supported profiles: http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-library | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version | |||
Location | http://hl7.org/fhir/StructureDefinition/Location | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier, name | |||
Measure | http://hl7.org/fhir/StructureDefinition/Measure Additional supported profiles: http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, depends-on, identifier, name, status, url, version | Measure:depends-on:Library | ||
MeasureReport | http://hl7.org/fhir/StructureDefinition/MeasureReport Additional supported profiles: http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure-report | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier | |||
NamingSystem | http://hl7.org/fhir/StructureDefinition/NamingSystem | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, name, status | |||
Organization | http://hl7.org/fhir/StructureDefinition/Organization Additional supported profiles: DSF Organization DSF Parent Organization | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _revinclude, _since, _sort, _summary, active, endpoint, identifier, name, type | Organization:endpoint:Endpoint | Endpoint:organization:Organization , OrganizationAffiliation:participating-organization:Organization , OrganizationAffiliation:primary-organization:Organization | |
OrganizationAffiliation | http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation Additional supported profiles: DSF OrganizationAffiliation | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, endpoint, identifier, participating-organization, primary-organization, role | OrganizationAffiliation:endpoint:Endpoint , OrganizationAffiliation:participating-organization:Organization , OrganizationAffiliation:primary-organization:Organization | ||
Patient | http://hl7.org/fhir/StructureDefinition/Patient | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier | |||
PractitionerRole | http://hl7.org/fhir/StructureDefinition/PractitionerRole | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier, organization, practitioner | PractitionerRole:organization:Organization , PractitionerRole:practitioner:Practitioner | ||
Practitioner | http://hl7.org/fhir/StructureDefinition/Practitioner | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier | |||
Provenance | http://hl7.org/fhir/StructureDefinition/Provenance | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary | |||
Questionnaire | http://hl7.org/fhir/StructureDefinition/Questionnaire | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version | |||
QuestionnaireResponse | http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, authored, identifier, status | |||
ResearchStudy | http://hl7.org/fhir/StructureDefinition/ResearchStudy | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, enrollment, identifier, principalinvestigator | ResearchStudy:enrollment:Group , ResearchStudy:principalinvestigator:Practitioner , ResearchStudy:principalinvestigator:PractitionerRole | ||
StructureDefinition | http://hl7.org/fhir/StructureDefinition/StructureDefinition | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version | $snapshot | ||
Subscription | http://hl7.org/fhir/StructureDefinition/Subscription | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, criteria, payload, status, type | |||
Task | http://hl7.org/fhir/StructureDefinition/Task Additional supported profiles: http://dsf.dev/fhir/StructureDefinition/task-cleanup-pong http://dsf.dev/fhir/StructureDefinition/task-download-allow-list http://dsf.dev/fhir/StructureDefinition/task-ping http://dsf.dev/fhir/StructureDefinition/task-pong http://dsf.dev/fhir/StructureDefinition/task-start-ping http://dsf.dev/fhir/StructureDefinition/task-start-ping-autostart http://dsf.dev/fhir/StructureDefinition/task-stop-ping-autostart http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-task-execute http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-task-request http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-task-single-dic-result http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-execute http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-request-start http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-response-failure http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-response-finished | y | y | y | y | y | y | _at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, authored-on, identifier, modified, requester, status | Task:requester:Organization , Task:requester:Patient , Task:requester:Practitioner , Task:requester:PractitionerRole | ||
ValueSet | http://hl7.org/fhir/StructureDefinition/ValueSet Additional supported profiles: ValueSet | y | y | y | y | y | y | _at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The activity definition publication date |
SHALL | identifier | token | External identifier for the activity definition |
SHALL | name | string | Computationally friendly name of the activity definition |
SHALL | status | token | The current status of the activity definition |
SHALL | url | uri | The uri that identifies the activity definition |
SHALL | version | token | The business version of the activity definition |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, contentType] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | contentType | token | The MIME type of the actual binary content |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | identifier | token | Persistent identifier for the bundle |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The code system publication date |
SHALL | identifier | token | External identifier for the code system |
SHALL | name | string | Computationally friendly name of the code system |
SHALL | status | token | The current status of the code system |
SHALL | url | uri | The uri that identifies the code system |
SHALL | version | token | The business version of the code system |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | identifier | token | Identifies this document reference across multiple systems |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [Endpoint:organization:Organization] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _revinclude | special | Additional resources to return, allowed values: [Organization:endpoint:Endpoint] (use one _revinclude parameter for every resource to include) |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, address, identifier, name, organization, status] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | address | uri | The address (url) of the endpoint |
SHALL | identifier | token | Identifies this endpoint across multiple systems |
SHALL | name | string | A name that this endpoint can be identified by |
SHALL | organization | reference | The organization that is managing the endpoint |
SHALL | status | token | The current status of the Endpoint (usually expected to be active) |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _revinclude | special | Additional resources to return, allowed values: [ResearchStudy:enrollment:Group] (use one _revinclude parameter for every resource to include) |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | identifier | token | External identifier for the group |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, identifier, name] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | active | token | The Healthcare Service is currently marked as active [true|false] |
SHALL | identifier | token | External identifiers for this item |
SHALL | name | string | A portion of the Healthcare service name |
http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-library
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The library publication date |
SHALL | identifier | token | External identifier for the library |
SHALL | name | string | Computationally friendly name of the library |
SHALL | status | token | The current status of the library |
SHALL | url | uri | The uri that identifies the library |
SHALL | version | token | The business version of the library |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier, name] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | identifier | token | An identifier for the location |
SHALL | name | string | Computationally friendly name of the library |
http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [Measure:depends-on:Library] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, depends-on, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The measure publication date |
SHALL | depends-on | reference | What resource is being referenced |
SHALL | identifier | token | External identifier for the measure |
SHALL | name | string | Computationally friendly name of the measure |
SHALL | status | token | The current status of the measure |
SHALL | url | uri | The uri that identifies the measure |
SHALL | version | token | The business version of the measure |
http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure-report
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | identifier | token | External identifier of the measure report to be returned |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, name, status] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The naming system publication date |
SHALL | name | string | Computationally friendly name of the naming system |
SHALL | status | token | The current status of the naming system |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [Organization:endpoint:Endpoint] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _revinclude | special | Additional resources to return, allowed values: [Endpoint:organization:Organization, OrganizationAffiliation:participating-organization:Organization, OrganizationAffiliation:primary-organization:Organization] (use one _revinclude parameter for every resource to include) |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, endpoint, identifier, name, type] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | active | token | Is the Organization record active [true|false] |
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 | name | string | A portion of the organization's name or alias |
SHALL | type | token | A code for the type of organization |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [OrganizationAffiliation:endpoint:Endpoint, OrganizationAffiliation:participating-organization:Organization, OrganizationAffiliation:primary-organization:Organization] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, endpoint, identifier, participating-organization, primary-organization, role] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | active | token | Whether this organization affiliation record is in active use [true|false] |
SHALL | endpoint | reference | Technical endpoints providing access to services operated for this role |
SHALL | identifier | token | An organization affiliation's Identifier |
SHALL | participating-organization | reference | The organization that provides services to the primary organization |
SHALL | primary-organization | reference | The organization that receives the services from the participating organization |
SHALL | role | token | Definition of the role the participatingOrganization plays |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | active | token | Whether the patient record is active [true|false] |
SHALL | identifier | token | A patient identifier |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [PractitionerRole:organization:Organization, PractitionerRole:practitioner:Practitioner] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, identifier, organization, practitioner] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | active | token | Whether this practitioner role record is in active use [true|false] |
SHALL | identifier | token | A practitioner's Identifier |
SHALL | organization | reference | The identity of the organization the practitioner represents / acts on behalf of |
SHALL | practitioner | reference | Practitioner that is able to provide the defined services for the organization |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | active | token | Whether the practitioner record is active [true|false] |
SHALL | identifier | token | A practitioner's Identifier |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The questionnaire publication date |
SHALL | identifier | token | External identifier for the questionnaire |
SHALL | name | string | Computationally friendly name of the questionnaire |
SHALL | status | token | The current status of the questionnaire |
SHALL | url | uri | The uri that identifies the questionnaire |
SHALL | version | token | The business version of the questionnaire |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, authored, identifier, status] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | authored | date | When the questionnaire response was last changed |
SHALL | identifier | token | The unique identifier for the questionnaire response |
SHALL | status | token | The status of the questionnaire response |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [ResearchStudy:enrollment:Group, ResearchStudy:principalinvestigator:Practitioner, ResearchStudy:principalinvestigator:PractitionerRole] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, enrollment, identifier, principalinvestigator] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | enrollment | reference | Search by research study enrollment |
SHALL | identifier | token | Business Identifier for study |
SHALL | principalinvestigator | reference | Researcher who oversees multiple aspects of the study |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The structure definition publication date |
SHALL | identifier | token | External identifier for the structure definition |
SHALL | name | string | Computationally friendly name of the structure definition |
SHALL | status | token | The current status of the structure definition |
SHALL | url | uri | The uri that identifies the structure definition |
SHALL | version | token | The business version of the structure definition |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $snapshot | Generates a StructureDefinition instance with a snapshot, based on a differential in a specified StructureDefinition |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, criteria, payload, status, type] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | criteria | string | The search rules used to determine when to send a notification (always matches exact) |
SHALL | payload | token | The mime-type of the notification payload |
SHALL | status | token | Search by subscription status |
SHALL | type | token | The type of channel for the sent notifications |
http://dsf.dev/fhir/StructureDefinition/task-cleanup-pong
http://dsf.dev/fhir/StructureDefinition/task-download-allow-list
http://dsf.dev/fhir/StructureDefinition/task-ping
http://dsf.dev/fhir/StructureDefinition/task-pong
http://dsf.dev/fhir/StructureDefinition/task-start-ping
http://dsf.dev/fhir/StructureDefinition/task-start-ping-autostart
http://dsf.dev/fhir/StructureDefinition/task-stop-ping-autostart
http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-task-execute
http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-task-request
http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-task-single-dic-result
http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-execute
http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-request-start
http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-response-failure
http://medizininformatik-initiative.de/fhir/StructureDefinition/task-omi-response-finished
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _include | special | Additional resources to return, allowed values: [Task:requester:Organization, Task:requester:Patient, Task:requester:Practitioner, Task:requester:PractitionerRole] (use one _include parameter for every resource to include) |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, authored-on, identifier, modified, requester, status] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | authored-on | date | Search by creation date |
SHALL | identifier | token | Search for a task instance by its business identifier |
SHALL | modified | date | Search by last modification date |
SHALL | requester | reference | Search by task requester |
SHALL | status | token | Search by task status |
create
, read
, vread
, update
, delete
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _at | date | Only include resource versions that were current at some point during the time period specified in the date time value |
SHALL | _count | number | Specify the numer of returned resources per page, 20 if not specified |
SHALL | _format | special | Specify the returned format of the payload response, allowed values: [json, application/json+fhir, application/fhir+json, application/json, xml, application/xml+fhir, application/fhir+xml, application/xml, text/xml] |
SHALL | _id | string | Logical id of this resource |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | _page | number | Specify the page number, 1 if not specified |
SHALL | _pretty | special | Pretty printed response for human convenience, allowed values: [true, false] |
SHALL | _profile | token | Profiles this resource claims to conform to |
SHALL | _since | special | Only include resource versions that were created at or after the given instant in time |
SHALL | _sort | special | Specify the returned order, allowed values: [_id, _lastUpdated, _profile, date, identifier, name, status, url, version] (one or multiple as comma separated string), prefix with '-' for reversed order |
SHALL | _summary | special | Predefined short form of the resource, allowed values: [true, text, data, count, false] |
SHALL | date | date | The value set publication date |
SHALL | identifier | token | External identifier for the value set |
SHALL | name | string | Computationally friendly name of the value set |
SHALL | status | token | The current status of the value set |
SHALL | url | uri | The uri that identifies the value set |
SHALL | version | token | The business version of the value set |