CH EPR FHIR (R4)
4.0.1-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot: DSTU 4 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: MHD Document Consumer (client)

Official URL: http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentConsumer Version: 4.0.1-ballot
Draft as of 2020-07-08 Computable Name: CH_MHD_DocumentConsumer

Copyright/Legal: CC0-1.0

CapabilityStatement for Actor MHD Document Consumer (client).

Raw OpenAPI-Swagger Definition file | Download

MHD Document Consumer (client)

  • Implementation Guide Version: 4.0.1-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2020-07-08
  • Published by: eHealth Suisse

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: client

MHD client requests a list of List Resources, matching the supplied set of criteria, from the Document Responder [ITI-66]. MHD client requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder [ITI-67]. MHD client requests a document from the Document Responder [ITI-68].

Security

TLS SHALL be used together with IUA extended access token

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

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 TypeProfileRSUCSearches_include_revincludeOperations
DocumentReferencehttp://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensiveyy_id, _lastUpdated, author, category, date, event, facility, format, identifier, patient, period, related, security-label, setting, status, type
Listhttp://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensiveyy_id, _lastupdated, code, creation, date, identifier, subject, source, status, designationType, sourceId
Binary y

Resource Conformance: supported DocumentReference

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALLauthorreference

Who and/or what authored the document

SHALLcategorytoken

Categorization of document

SHALLdatedate

When this document reference was created

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLidentifiertoken

The identifier for this DocumentReference

SHALLpatientreference

Who/what is the subject of the document

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related Resource

SHALLsecurity-labeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLtypetoken

Kind of document (LOINC if possible)

 

Resource Conformance: supported List

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastupdateddate

When the resource version last changed

SHALLcodetoken

This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated.

SHALLcreationdate

When this document was created

SHALLdatedate

This parameter, of type date, specifies the time when the List was created.

SHALLidentifiertoken

This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2: Appendix Z.2 for additional constraints on the use of the token search parameter type.

SHALLsubjectreference

This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder.

SHALLsourcereference

These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2: Appendix Z.2 for use of the string data type.

SHALLstatustoken

This parameter, of type token, specifies the status of the List. If included in the query, the Document Consumer shall populate the code portion of the token with one of the codes in the following Table 3.66.4.1.2.1-1: Values for code for status of List. The system portion of the token shall not be populated.

SHALLdesignationTypetoken

This IHE extension on parameters defined as SearchParameter/List-DesignationType, of type token, specifies the designation type of the List. The value of the designation type element indicates the clinical purpose of the SubmissionSet or Folder. Note that servers that do not support this extended search parameter will ignore it, and thus return more results than expected.

SHALLsourceIdtoken

This IHE extension on parameters defined as SearchParameter/List-SourceId, of type token, specifies the source (author) value supplied in the List Resource.

 

Resource Conformance: supported Binary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports read.