CH.MHD.DocumentConsumer
type: CapabilityStatement
node role: treeRoot
id:
  v: CH.MHD.DocumentConsumer
text:
  status:
    v: extensions
  div: Generated Narrative: CapabilityStatement CH.MHD.DocumentConsumer MHD Document Consumer (client) Implementation Guide Version: 5.0.0-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 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 Type Profile R S U C Searches _include _revinclude Operations DocumentReference http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive y y _id, _lastUpdated, author, category, date, event, facility, format, identifier, patient, period, related, security-label, setting, status, type List http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive y y _id, _lastupdated, code, creatio…
url:
  v: http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentConsumer
version:
  v: 5.0.0-ballot
name:
  v: CH_MHD_DocumentConsumer
title:
  v: MHD Document Consumer (client)
status:
  v: active
date:
  v: 2020-07-08
publisher:
  v: eHealth Suisse
contact:
  name:
    v: eHealth Suisse
  telecom:
    system:
      v: url
    value:
      v: https://www.e-health-suisse.ch
contact:
  name:
    v: eHealth Suisse
  telecom:
    system:
      v: url
    value:
      v: https://www.e-health-suisse.ch
    use:
      v: work
description:
  v: CapabilityStatement for Actor MHD Document Consumer (client).
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: CH
copyright:
  v: CC0-1.0
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: application/fhir+xml
format:
  v: application/fhir+json
rest:
  mode:
    v: client
  documentation:
    v: 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:
    cors:
      v: false
    description:
      v: TLS SHALL be used together with IUA extended access token
  resource:
    type:
      v: DocumentReference
    profile:
      v: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive
      link: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive
    interaction:
      code:
        v: read
    interaction:
      code:
        v: search-type
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact
    search param:
      name:
        v: _lastUpdated
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
        link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
      type:
        v: date
      documentation:
        v: When the resource version last changed
    search param:
      name:
        v: author
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-author
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-author
      type:
        v: reference
      documentation:
        v: Who and/or what authored the document
    search param:
      name:
        v: category
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-category
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-category
      type:
        v: token
      documentation:
        v: Categorization of document
    search param:
      name:
        v: date
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-date
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-date
      type:
        v: date
      documentation:
        v: When this document reference was created
    search param:
      name:
        v: event
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-event
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-event
      type:
        v: token
      documentation:
        v: Main clinical acts documented
    search param:
      name:
        v: facility
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-facility
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-facility
      type:
        v: token
      documentation:
        v: Kind of facility where patient was seen
    search param:
      name:
        v: format
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-format
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-format
      type:
        v: token
      documentation:
        v: Format/content rules for the document
    search param:
      name:
        v: identifier
      definition:
        v: http://hl7.org/fhir/SearchParameter/clinical-identifier
        link: http://hl7.org/fhir/SearchParameter/clinical-identifier
      type:
        v: token
      documentation:
        v: The identifier for this DocumentReference
    search param:
      name:
        v: patient
      definition:
        v: http://hl7.org/fhir/SearchParameter/clinical-patient
        link: http://hl7.org/fhir/SearchParameter/clinical-patient
      type:
        v: reference
      documentation:
        v: Who/what is the subject of the document
    search param:
      name:
        v: period
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-period
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-period
      type:
        v: date
      documentation:
        v: Time of service that is being documented
    search param:
      name:
        v: related
      definition:
        v: http://hl7.org/fhir/SearchParameter/DocumentReference-related
        link: http://hl7.org/fhir/SearchParameter/DocumentReference-related
      type:
        v: reference
      documentation:
        v: Related Resource
    search param:
      name:
        v: security-label

v: token

v: Document security-tags

name:
  v: setting
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-setting
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-setting
type:
  v: token
documentation:
  v: Additional details about where the content was created (e.g. clinical specialty)

name:
  v: status
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-status
  link: http://hl7.org/fhir/SearchParameter/DocumentReference-status
type:
  v: token
documentation:
  v: current | superseded | entered-in-error

name:
  v: type
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-type
  link: http://hl7.org/fhir/SearchParameter/clinical-type
type:
  v: token
documentation:
  v: Kind of document (LOINC if possible)

type:
  v: List
profile:
  v: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive
  link: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
search param:
  name:
    v: _lastupdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  type:
    v: date
  documentation:
    v: When the resource version last changed
search param:
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  type:
    v: token
  documentation:
    v: 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.
search param:
  name:
    v: creation
  definition:
    v: https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation
    link: https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation
  type:
    v: date
  documentation:
    v: When this document was created
search param:
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-date
    link: http://hl7.org/fhir/SearchParameter/clinical-date
  type:
    v: date
  documentation:
    v: This parameter, of type date, specifies the time when the List was created.
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
  documentation:
    v: 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.
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: 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.

type:
  v: Binary
interaction:
  code:
    v: read

code:
  v: search-system