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

CapabilityStatement:

Official URL: http://dsf.dev/fhir/CapabilityStatement/dsf Version:
Active as of 2025-03-24 Computable Name:

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: null
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Supported Patch Formats:
  • Published on: 2025-03-24 19:43:20+0100
  • Published by: DSF Community

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

Security
Enable CORS: no
Security services supported: Certificates, OAuth
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUCDSearches_include_revincludeOperations
ActivityDefinitionhttp://hl7.org/fhir/StructureDefinition/ActivityDefinition
Additional supported profiles:
  DSF ActivityDefinition
yyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, contentType
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier
CodeSystemhttp://hl7.org/fhir/StructureDefinition/CodeSystem
Additional supported profiles:
  CodeSystem
yyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version
DocumentReferencehttp://hl7.org/fhir/StructureDefinition/DocumentReferenceyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier
Endpointhttp://hl7.org/fhir/StructureDefinition/Endpoint
Additional supported profiles:
  DSF Endpoint
yyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _revinclude, _since, _sort, _summary, address, identifier, name, organization, statusEndpoint:organization:OrganizationOrganization:endpoint:Endpoint
Grouphttp://hl7.org/fhir/StructureDefinition/Groupyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _revinclude, _since, _sort, _summary, identifierResearchStudy:enrollment:Group
HealthcareServicehttp://hl7.org/fhir/StructureDefinition/HealthcareServiceyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier, name
Libraryhttp://hl7.org/fhir/StructureDefinition/Library
Additional supported profiles:
  http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-library
yyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version
Locationhttp://hl7.org/fhir/StructureDefinition/Locationyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier, name
Measurehttp://hl7.org/fhir/StructureDefinition/Measure
Additional supported profiles:
  http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure
yyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, depends-on, identifier, name, status, url, versionMeasure:depends-on:Library
MeasureReporthttp://hl7.org/fhir/StructureDefinition/MeasureReport
Additional supported profiles:
  http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure-report
yyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, identifier
NamingSystemhttp://hl7.org/fhir/StructureDefinition/NamingSystemyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, name, status
Organizationhttp://hl7.org/fhir/StructureDefinition/Organization
Additional supported profiles:
  DSF Organization
  DSF Parent Organization
yyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _revinclude, _since, _sort, _summary, active, endpoint, identifier, name, typeOrganization:endpoint:EndpointEndpoint:organization:Organization, OrganizationAffiliation:participating-organization:Organization, OrganizationAffiliation:primary-organization:Organization
OrganizationAffiliationhttp://hl7.org/fhir/StructureDefinition/OrganizationAffiliation
Additional supported profiles:
  DSF OrganizationAffiliation
yyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, endpoint, identifier, participating-organization, primary-organization, roleOrganizationAffiliation:endpoint:Endpoint, OrganizationAffiliation:participating-organization:Organization, OrganizationAffiliation:primary-organization:Organization
Patienthttp://hl7.org/fhir/StructureDefinition/Patientyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier
PractitionerRolehttp://hl7.org/fhir/StructureDefinition/PractitionerRoleyyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier, organization, practitionerPractitionerRole:organization:Organization, PractitionerRole:practitioner:Practitioner
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioneryyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, active, identifier
Provenancehttp://hl7.org/fhir/StructureDefinition/Provenanceyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary
Questionnairehttp://hl7.org/fhir/StructureDefinition/Questionnaireyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version
QuestionnaireResponsehttp://hl7.org/fhir/StructureDefinition/QuestionnaireResponseyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, authored, identifier, status
ResearchStudyhttp://hl7.org/fhir/StructureDefinition/ResearchStudyyyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, enrollment, identifier, principalinvestigatorResearchStudy:enrollment:Group, ResearchStudy:principalinvestigator:Practitioner, ResearchStudy:principalinvestigator:PractitionerRole
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinitionyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version$snapshot
Subscriptionhttp://hl7.org/fhir/StructureDefinition/Subscriptionyyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, criteria, payload, status, type
Taskhttp://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
yyyyyy_at, _count, _format, _id, _include, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, authored-on, identifier, modified, requester, statusTask:requester:Organization, Task:requester:Patient, Task:requester:Practitioner, Task:requester:PractitionerRole
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSet
Additional supported profiles:
  ValueSet
yyyyyy_at, _count, _format, _id, _lastUpdated, _page, _pretty, _profile, _since, _sort, _summary, date, identifier, name, status, url, version

Resource Conformance: supported ActivityDefinition

Base System Profile
ActivityDefinition
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

DSF ActivityDefinition

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The activity definition publication date

SHALLidentifiertoken

External identifier for the activity definition

SHALLnamestring

Computationally friendly name of the activity definition

SHALLstatustoken

The current status of the activity definition

SHALLurluri

The uri that identifies the activity definition

SHALLversiontoken

The business version of the activity definition

 

Resource Conformance: supported Binary

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, contentType] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLcontentTypetoken

The MIME type of the actual binary content

 

Resource Conformance: supported Bundle

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLidentifiertoken

Persistent identifier for the bundle

 

Resource Conformance: supported CodeSystem

Base System Profile
CodeSystem
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

CodeSystem

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The code system publication date

SHALLidentifiertoken

External identifier for the code system

SHALLnamestring

Computationally friendly name of the code system

SHALLstatustoken

The current status of the code system

SHALLurluri

The uri that identifies the code system

SHALLversiontoken

The business version of the code system

 

Resource Conformance: supported DocumentReference

Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLidentifiertoken

Identifies this document reference across multiple systems

 

Resource Conformance: supported Endpoint

Base System Profile
Endpoint
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

DSF Endpoint

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

Additional resources to return, allowed values: [Endpoint:organization:Organization] (use one _include parameter for every resource to include)

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_revincludespecial

Additional resources to return, allowed values: [Organization:endpoint:Endpoint] (use one _revinclude parameter for every resource to include)

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLaddressuri

The address (url) of the endpoint

SHALLidentifiertoken

Identifies this endpoint across multiple systems

SHALLnamestring

A name that this endpoint can be identified by

SHALLorganizationreference

The organization that is managing the endpoint

SHALLstatustoken

The current status of the Endpoint (usually expected to be active)

 

Resource Conformance: supported Group

Base System Profile
Group
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_revincludespecial

Additional resources to return, allowed values: [ResearchStudy:enrollment:Group] (use one _revinclude parameter for every resource to include)

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLidentifiertoken

External identifier for the group

 

Resource Conformance: supported HealthcareService

Base System Profile
HealthcareService
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLactivetoken

The Healthcare Service is currently marked as active [true|false]

SHALLidentifiertoken

External identifiers for this item

SHALLnamestring

A portion of the Healthcare service name

 

Resource Conformance: supported Library

Base System Profile
Library
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-library

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The library publication date

SHALLidentifiertoken

External identifier for the library

SHALLnamestring

Computationally friendly name of the library

SHALLstatustoken

The current status of the library

SHALLurluri

The uri that identifies the library

SHALLversiontoken

The business version of the library

 

Resource Conformance: supported Location

Base System Profile
Location
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier, name] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLidentifiertoken

An identifier for the location

SHALLnamestring

Computationally friendly name of the library

 

Resource Conformance: supported Measure

Base System Profile
Measure
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

Additional resources to return, allowed values: [Measure:depends-on:Library] (use one _include parameter for every resource to include)

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The measure publication date

SHALLdepends-onreference

What resource is being referenced

SHALLidentifiertoken

External identifier for the measure

SHALLnamestring

Computationally friendly name of the measure

SHALLstatustoken

The current status of the measure

SHALLurluri

The uri that identifies the measure

SHALLversiontoken

The business version of the measure

 

Resource Conformance: supported MeasureReport

Base System Profile
MeasureReport
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

http://medizininformatik-initiative.de/fhir/StructureDefinition/feasibility-measure-report

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLidentifiertoken

External identifier of the measure report to be returned

 

Resource Conformance: supported NamingSystem

Base System Profile
NamingSystem
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The naming system publication date

SHALLnamestring

Computationally friendly name of the naming system

SHALLstatustoken

The current status of the naming system

 

Resource Conformance: supported Organization

Base System Profile
Organization
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

Additional resources to return, allowed values: [Organization:endpoint:Endpoint] (use one _include parameter for every resource to include)

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_revincludespecial

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_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLactivetoken

Is the Organization record active [true|false]

SHALLendpointreference

Technical endpoints providing access to services operated for the organization

SHALLidentifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALLnamestring

A portion of the organization's name or alias

SHALLtypetoken

A code for the type of organization

 

Resource Conformance: supported OrganizationAffiliation

Base System Profile
OrganizationAffiliation
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

DSF OrganizationAffiliation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

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_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLactivetoken

Whether this organization affiliation record is in active use [true|false]

SHALLendpointreference

Technical endpoints providing access to services operated for this role

SHALLidentifiertoken

An organization affiliation's Identifier

SHALLparticipating-organizationreference

The organization that provides services to the primary organization

SHALLprimary-organizationreference

The organization that receives the services from the participating organization

SHALLroletoken

Definition of the role the participatingOrganization plays

 

Resource Conformance: supported Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLactivetoken

Whether the patient record is active [true|false]

SHALLidentifiertoken

A patient identifier

 

Resource Conformance: supported PractitionerRole

Base System Profile
PractitionerRole
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

Additional resources to return, allowed values: [PractitionerRole:organization:Organization, PractitionerRole:practitioner:Practitioner] (use one _include parameter for every resource to include)

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLactivetoken

Whether this practitioner role record is in active use [true|false]

SHALLidentifiertoken

A practitioner's Identifier

SHALLorganizationreference

The identity of the organization the practitioner represents / acts on behalf of

SHALLpractitionerreference

Practitioner that is able to provide the defined services for the organization

 

Resource Conformance: supported Practitioner

Base System Profile
Practitioner
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile, active, identifier] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLactivetoken

Whether the practitioner record is active [true|false]

SHALLidentifiertoken

A practitioner's Identifier

 

Resource Conformance: supported Provenance

Base System Profile
Provenance
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

Specify the returned order, allowed values: [_id, _lastUpdated, _profile] (one or multiple as comma separated string), prefix with '-' for reversed order

SHALL_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

 

Resource Conformance: supported Questionnaire

Base System Profile
Questionnaire
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The questionnaire publication date

SHALLidentifiertoken

External identifier for the questionnaire

SHALLnamestring

Computationally friendly name of the questionnaire

SHALLstatustoken

The current status of the questionnaire

SHALLurluri

The uri that identifies the questionnaire

SHALLversiontoken

The business version of the questionnaire

 

Resource Conformance: supported QuestionnaireResponse

Base System Profile
QuestionnaireResponse
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLauthoreddate

When the questionnaire response was last changed

SHALLidentifiertoken

The unique identifier for the questionnaire response

SHALLstatustoken

The status of the questionnaire response

 

Resource Conformance: supported ResearchStudy

Base System Profile
ResearchStudy
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

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_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLenrollmentreference

Search by research study enrollment

SHALLidentifiertoken

Business Identifier for study

SHALLprincipalinvestigatorreference

Researcher who oversees multiple aspects of the study

 

Resource Conformance: supported StructureDefinition

Base System Profile
StructureDefinition
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The structure definition publication date

SHALLidentifiertoken

External identifier for the structure definition

SHALLnamestring

Computationally friendly name of the structure definition

SHALLstatustoken

The current status of the structure definition

SHALLurluri

The uri that identifies the structure definition

SHALLversiontoken

The business version of the structure definition

 
Extended Operations
ConformanceOperationDocumentation
SHALL$snapshot

Generates a StructureDefinition instance with a snapshot, based on a differential in a specified StructureDefinition

Resource Conformance: supported Subscription

Base System Profile
Subscription
Profile Conformance
SHALL
Reference Policy
literal, logical

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLcriteriastring

The search rules used to determine when to send a notification (always matches exact)

SHALLpayloadtoken

The mime-type of the notification payload

SHALLstatustoken

Search by subscription status

SHALLtypetoken

The type of channel for the sent notifications

 

Resource Conformance: supported Task

Base System Profile
Task
Profile Conformance
SHALL
Reference Policy
literal, logical

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

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_includespecial

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_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLauthored-ondate

Search by creation date

SHALLidentifiertoken

Search for a task instance by its business identifier

SHALLmodifieddate

Search by last modification date

SHALLrequesterreference

Search by task requester

SHALLstatustoken

Search by task status

 

Resource Conformance: supported ValueSet

Base System Profile
ValueSet
Profile Conformance
SHALL
Reference Policy
literal, logical

Supported Profiles

ValueSet

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_atdate

Only include resource versions that were current at some point during the time period specified in the date time value

SHALL_countnumber

Specify the numer of returned resources per page, 20 if not specified

SHALL_formatspecial

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_idstring

Logical id of this resource

SHALL_lastUpdateddate

When the resource version last changed

SHALL_pagenumber

Specify the page number, 1 if not specified

SHALL_prettyspecial

Pretty printed response for human convenience, allowed values: [true, false]

SHALL_profiletoken

Profiles this resource claims to conform to

SHALL_sincespecial

Only include resource versions that were created at or after the given instant in time

SHALL_sortspecial

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_summaryspecial

Predefined short form of the resource, allowed values: [true, text, data, count, false]

SHALLdatedate

The value set publication date

SHALLidentifiertoken

External identifier for the value set

SHALLnamestring

Computationally friendly name of the value set

SHALLstatustoken

The current status of the value set

SHALLurluri

The uri that identifies the value set

SHALLversiontoken

The business version of the value set