CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot
CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot
This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot-2: DSTU 4 Ballot 3) 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
| Draft as of 2020-07-08 |
{
"resourceType" : "CapabilityStatement",
"id" : "CH.MHD.DocumentConsumer",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement CH.MHD.DocumentConsumer</b></p><a name=\"CH.MHD.DocumentConsumer\"> </a><a name=\"hcCH.MHD.DocumentConsumer\"> </a><a name=\"CH.MHD.DocumentConsumer-en-US\"> </a><h2 id=\"title\">MHD Document Consumer (client)</h2><ul><li>Implementation Guide Version: 4.0.1-ballot-2 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-07-08 </li><li>Published by: eHealth Suisse </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>MHD client requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder [ITI-67].\nMHD client requests a document from the Document Responder [ITI-68].</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>TLS SHALL be used together with IUA extended access token</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#DocumentReference1-1\">DocumentReference</a></td><td><a href=\"StructureDefinition-ch-mhd-documentreference-comprehensive.html\">http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, author, category, date, event, facility, format, identifier, patient, period, related, security-label, setting, status, type</td><td/><td/><td/></tr><tr><td><a href=\"#List1-2\">List</a></td><td><a href=\"StructureDefinition-ch-mhd-submissionset-comprehensive.html\">http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastupdated, code, creation, date, identifier, subject</td><td/><td/><td/></tr><tr><td><a href=\"#Binary1-3\">Binary</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ch-mhd-documentreference-comprehensive.html\">CH MHD DocumentReference Comprehensive</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">author</a></td><td><code>reference</code></td><td><div><p>Who and/or what authored the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a></td><td><code>token</code></td><td><div><p>Categorization of document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>date</code></td><td><div><p>When this document reference was created</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">event</a></td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">facility</a></td><td><code>token</code></td><td><div><p>Kind of facility where patient was seen</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">format</a></td><td><code>token</code></td><td><div><p>Format/content rules for the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The identifier for this DocumentReference</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">period</a></td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">related</a></td><td><code>reference</code></td><td><div><p>Related Resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">security-label</a></td><td><code>token</code></td><td><div><p>Document security-tags</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">setting</a></td><td><code>token</code></td><td><div><p>Additional details about where the content was created (e.g. clinical specialty)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">status</a></td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a></td><td><code>token</code></td><td><div><p>Kind of document (LOINC if possible)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"List1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>List</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ch-mhd-submissionset-comprehensive.html\">CH MHD SubmissionSet Comprehensive</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastupdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">code</a></td><td><code>token</code></td><td><div><p>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.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/SearchParameter-DocumentReference-Creation.html\">creation</a></td><td><code>date</code></td><td><div><p>When this document was created</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">date</a></td><td><code>date</code></td><td><div><p>This parameter, of type date, specifies the time when the List was created.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>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.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">subject</a></td><td><code>reference</code></td><td><div><p>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.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Binary</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/></div></div></div></div>"
},
"url" : "http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentConsumer",
"version" : "4.0.1-ballot-2",
"name" : "CH_MHD_DocumentConsumer",
"title" : "MHD Document Consumer (client)",
"status" : "draft",
"date" : "2020-07-08",
"publisher" : "eHealth Suisse",
"contact" : [
{
"name" : "eHealth Suisse",
"telecom" : [
{
"system" : "url",
"value" : "https://www.e-health-suisse.ch"
}
]
}
],
"description" : "CapabilityStatement for Actor MHD Document Consumer (client).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "CH"
}
]
}
],
"copyright" : "CC0-1.0",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "MHD client requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder [ITI-67].\n MHD client requests a document from the Document Responder [ITI-68].",
"security" : {
"cors" : false,
"description" : "TLS SHALL be used together with IUA extended access token"
},
"resource" : [
{
"type" : "DocumentReference",
"profile" : "http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"type" : "reference",
"documentation" : "Who and/or what authored the document"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Categorization of document"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type" : "date",
"documentation" : "When this document reference was created"
},
{
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type" : "token",
"documentation" : "Main clinical acts documented"
},
{
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type" : "token",
"documentation" : "Kind of facility where patient was seen"
},
{
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type" : "token",
"documentation" : "Format/content rules for the document"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "The identifier for this DocumentReference"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date",
"documentation" : "Time of service that is being documented"
},
{
"name" : "related",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"type" : "reference",
"documentation" : "Related Resource"
},
{
"name" : "security-label",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type" : "token",
"documentation" : "Document security-tags"
},
{
"name" : "setting",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type" : "token",
"documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Kind of document (LOINC if possible)"
}
]
},
{
"type" : "List",
"profile" : "http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "_lastupdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "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."
},
{
"name" : "creation",
"definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
"type" : "date",
"documentation" : "When this document was created"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "This parameter, of type date, specifies the time when the List was created."
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "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."
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "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" : "Binary",
"interaction" : [
{
"code" : "read"
}
]
}
],
"interaction" : [
{
"code" : "search-system"
}
]
}
]
}