CH EPR mHealth (R4)
0.1.1 - Draft Standard for Trial Use

This page is part of the CH EPR mHealth (R4) (v0.1.1: DSTU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

MHD Document Responder (server) - XML Representation

(back to description)

Raw xml

Source view 


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="CH.MHD.DocumentResponder"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>CH_MHD_DocumentResponder</h2><div><p>CapabilityStatement for Actor MHD Document Responder (server).</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td>MHD server returns DocumentManifest Resources that match the search criteria provided by the Document Consumer [ITI-66].          MHD server returns DocumentReference Resources that match the search criteria provided by the Document Consumer [ITI-67].         MHD server serves the document to the Document Consumer [ITI-68].</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>DocumentManifest</td><td><a href="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-comprehensive-documentmanifest">http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-comprehensive-documentmanifest</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>DocumentReference</td><td><a href="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-query-comprehensive-documentreference">http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-query-comprehensive-documentreference</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Binary</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.DocumentResponder"/>
  <version value="0.1.1"/>
  <name value="CH_MHD_DocumentResponder"/>
  <title value="MHD Document Responder (server)"/>
  <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 Responder (server)."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="CH"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="MHD server returns DocumentManifest Resources that match the search criteria provided by the Document Consumer [ITI-66].          MHD server returns DocumentReference Resources that match the search criteria provided by the Document Consumer [ITI-67].         MHD server serves the document to the Document Consumer [ITI-68]."/>
    <security>
      <cors value="false"/>
      <description value="TLS SHALL be used"/>
    </security>
    <resource>
      <type value="DocumentManifest"/>
      <profile
               value="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-comprehensive-documentmanifest"/>
      <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="patient"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
        <type value="reference"/>
        <documentation value="The subject of the set of documents"/>
      </searchParam>
      <searchParam>
        <name value="patient.identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/>
        <type value="token"/>
        <documentation value="A patient identifier"/>
      </searchParam>
      <searchParam>
        <name value="created"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentManifest-created"/>
        <type value="date"/>
        <documentation value="When this document manifest created"/>
      </searchParam>
      <searchParam>
        <name value="author"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentManifest-author"/>
        <type value="reference"/>
        <documentation value="Who and/or what authored the DocumentManifest"/>
      </searchParam>
      <searchParam>
        <name value="author.given"/>
        <definition value="http://hl7.org/fhir/SearchParameter/individual-given"/>
        <type value="string"/>
        <documentation value="A portion of the given name"/>
      </searchParam>
      <searchParam>
        <name value="author.family"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/individual-family"/>
        <type value="string"/>
        <documentation value="A portion of the family name"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
        <type value="token"/>
        <documentation value="Unique Identifier for the set of documents"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentManifest-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 set"/>
      </searchParam>
      <searchParam>
        <name value="source"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentManifest-source"/>
        <type value="uri"/>
        <documentation value="The source system/application/software"/>
      </searchParam>
    </resource>
    <resource>
      <type value="DocumentReference"/>
      <profile
               value="http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-query-comprehensive-documentreference"/>
      <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="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="patient.identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/>
        <type value="token"/>
        <documentation value="A patient identifier"/>
      </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="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
        <type value="token"/>
        <documentation value="Master Version Specific Identifier"/>
      </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="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="author.given"/>
        <definition value="http://hl7.org/fhir/SearchParameter/individual-given"/>
        <type value="string"/>
        <documentation value="A portion of the given name"/>
      </searchParam>
      <searchParam>
        <name value="author.family"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/individual-family"/>
        <type value="string"/>
        <documentation value="A portion of the family name"/>
      </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="type"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-type"/>
        <type value="token"/>
        <documentation value="Kind of document (LOINC if possible)"/>
      </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="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="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="event"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-event"/>
        <type value="token"/>
        <documentation value="Main clinical acts documented"/>
      </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="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="related"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DocumentReference-related"/>
        <type value="reference"/>
        <documentation value="Related identifiers or resources"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Binary"/>
      <interaction>
        <code value="read"/>
      </interaction>
    </resource>
    <interaction>
      <code value="search-system"/>
    </interaction>
  </rest>
</CapabilityStatement>