CH EPR mHealth (R4)
1.1.0 - CI Build Switzerland flag

CH EPR mHealth (R4), published by eHealth Suisse. This is not an authorized publication; it is the continuous build for version 1.1.0). This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-mhealth/ and changes regularly. See the Directory of published versions

: MHD Document Consumer (client) - XML Representation

Draft as of 2020-07-08

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="CH.MHD.DocumentConsumer"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>CH_MHD_DocumentConsumer</h2><div><p>CapabilityStatement for Actor MHD Document Consumer (client).</p>
</div><table><tr><td>Mode</td><td>CLIENT</td></tr><tr><td>Description</td><td><div><p>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].</p>
</div></td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>DocumentReference</td><td><a href="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-documentreference-comprehensive">http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-documentreference-comprehensive</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>List</td><td><a href="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-submissionset-comprehensive">http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-submissionset-comprehensive</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Binary</td><td> </td><td>y</td><td></td><td></td><td></td></tr></table></div>
  </text>
  <url
       value="http://fhir.ch/ig/ch-epr-mhealth/CapabilityStatement/CH.MHD.DocumentConsumer"/>
  <version value="1.1.0"/>
  <name value="CH_MHD_DocumentConsumer"/>
  <title value="MHD Document Consumer (client)"/>
  <status value="draft"/>
  <date value="2020-07-08"/>
  <publisher value="eHealth Suisse"/>
  <contact>
    <name value="eHealth Suisse"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.e-health-suisse.ch"/>
    </telecom>
  </contact>
  <description
               value="CapabilityStatement for Actor MHD Document Consumer (client)."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="CH"/>
    </coding>
  </jurisdiction>
  <copyright value="CC-BY-SA-4.0"/>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="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>
      <cors value="false"/>
      <description
                   value="TLS SHALL be used together with IUA extended access token"/>
    </security>
    <resource>
      <type value="DocumentReference"/>
      <profile
               value="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-documentreference-comprehensive"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
        <type value="token"/>
        <documentation value="Logical id of this artifact"/>
      </searchParam>
      <searchParam>
        <name value="_lastUpdated"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
        <type value="date"/>
        <documentation value="When the resource version last changed"/>
      </searchParam>
      <searchParam>
        <name value="author"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-author"/>
        <type value="reference"/>
        <documentation value="Who and/or what authored the document"/>
      </searchParam>
      <searchParam>
        <name value="category"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-category"/>
        <type value="token"/>
        <documentation value="Categorization of document"/>
      </searchParam>
      <searchParam>
        <name value="date"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-date"/>
        <type value="date"/>
        <documentation value="When this document reference was created"/>
      </searchParam>
      <searchParam>
        <name value="event"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-event"/>
        <type value="token"/>
        <documentation value="Main clinical acts documented"/>
      </searchParam>
      <searchParam>
        <name value="facility"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-facility"/>
        <type value="token"/>
        <documentation value="Kind of facility where patient was seen"/>
      </searchParam>
      <searchParam>
        <name value="format"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-format"/>
        <type value="token"/>
        <documentation value="Format/content rules for the document"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
        <type value="token"/>
        <documentation value="The identifier for this DocumentReference"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
        <type value="reference"/>
        <documentation value="Who/what is the subject of the document"/>
      </searchParam>
      <searchParam>
        <name value="period"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-period"/>
        <type value="date"/>
        <documentation value="Time of service that is being documented"/>
      </searchParam>
      <searchParam>
        <name value="related"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-related"/>
        <type value="reference"/>
        <documentation value="Related Resource"/>
      </searchParam>
      <searchParam>
        <name value="security-label"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-security-label"/>
        <type value="token"/>
        <documentation value="Document security-tags"/>
      </searchParam>
      <searchParam>
        <name value="setting"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-setting"/>
        <type value="token"/>
        <documentation
                       value="Additional details about where the content was created (e.g. clinical specialty)"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-status"/>
        <type value="token"/>
        <documentation value="current | superseded | entered-in-error"/>
      </searchParam>
      <searchParam>
        <name value="type"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-type"/>
        <type value="token"/>
        <documentation value="Kind of document (LOINC if possible)"/>
      </searchParam>
    </resource>
    <resource>
      <type value="List"/>
      <profile
               value="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-submissionset-comprehensive"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
        <type value="token"/>
        <documentation value="Logical id of this artifact"/>
      </searchParam>
      <searchParam>
        <name value="_lastupdated"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
        <type value="date"/>
        <documentation value="When the resource version last changed"/>
      </searchParam>
      <searchParam>
        <name value="code"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
        <type value="token"/>
        <documentation
                       value="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."/>
      </searchParam>
      <searchParam>
        <name value="date"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
        <type value="date"/>
        <documentation
                       value="This parameter, of type date, specifies the time when the List was created."/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
        <type value="token"/>
        <documentation
                       value="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."/>
      </searchParam>
      <searchParam>
        <name value="subject"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
        <type value="reference"/>
        <documentation
                       value="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."/>
      </searchParam>
      <searchParam>
        <name value="source"/>
        <definition value="http://hl7.org/fhir/SearchParameter/List-source"/>
        <type value="reference"/>
        <documentation
                       value="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."/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition value="http://hl7.org/fhir/SearchParameter/List-status"/>
        <type value="token"/>
        <documentation
                       value="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."/>
      </searchParam>
      <searchParam>
        <name value="designationType"/>
        <definition
                    value="http://profiles.ihe.net/ITI/MHD/SearchParameter/List-DesignationType"/>
        <type value="token"/>
        <documentation
                       value="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."/>
      </searchParam>
      <searchParam>
        <name value="sourceId"/>
        <definition
                    value="http://profiles.ihe.net/ITI/MHD/SearchParameter/List-SourceId"/>
        <type value="reference"/>
        <documentation
                       value="This IHE extension on parameters defined as SearchParameter/List-SourceId, of type reference, specifies the source (author) value supplied in the List Resource."/>
      </searchParam>
    </resource>
    <resource>
      <type value="Binary"/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <interaction>
      <code value="search-system"/>
    </interaction>
  </rest>
</CapabilityStatement>