MyHealth@Eu NCPeH API
0.0.1 - ci-build
150
MyHealth@Eu NCPeH API
0.0.1 - ci-build
150
MyHealth@Eu NCPeH API - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-06-27 |
{
"resourceType" : "CapabilityStatement",
"id" : "a87fce1b-c081-4667-a092-64834ab7e05b",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement a87fce1b-c081-4667-a092-64834ab7e05b</b></p><a name=\"a87fce1b-c081-4667-a092-64834ab7e05b\"> </a><a name=\"hca87fce1b-c081-4667-a092-64834ab7e05b\"> </a><a name=\"a87fce1b-c081-4667-a092-64834ab7e05b-en-US\"> </a><h2 id=\"title\"/><ul><li>Implementation Guide Version: 0.0.1 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>xml</code>, <code>application/fhir+json</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-06-27 10:58:29+0000 </li><li>Published by: MyHealthEu </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>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></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=\"#Bundle1-1\">Bundle</a></td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">http://hl7.org/fhir/StructureDefinition/Bundle</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>category, date, patient, specialty, type</td><td><code>*</code>, <code>Bundle:patient</code></td><td><code>Bundle:patient</code>, <code>Composition:patient</code>, <code>DiagnosticReport:patient</code>, <code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#Composition1-2\">Composition</a></td><td><a href=\"http://hl7.org/fhir/R4/composition.html\">http://hl7.org/fhir/StructureDefinition/Composition</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>category, date, patient, specialty, type</td><td><code>*</code>, <code>Composition:patient</code></td><td><code>Bundle:patient</code>, <code>Composition:patient</code>, <code>DiagnosticReport:patient</code>, <code>DocumentReference:patient</code></td><td><code>$document</code></td></tr><tr><td><a href=\"#DiagnosticReport1-3\">DiagnosticReport</a></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html\">http://hl7.org/fhir/StructureDefinition/DiagnosticReport</a></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>category, contenttype, date, patient, type</td><td><code>*</code>, <code>DiagnosticReport:patient</code></td><td><code>Bundle:patient</code>, <code>Composition:patient</code>, <code>DiagnosticReport:patient</code>, <code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#DocumentReference1-4\">DocumentReference</a></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html\">http://hl7.org/fhir/StructureDefinition/DocumentReference</a></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>category, contenttype, date, patient, type</td><td><code>*</code>, <code>DocumentReference:patient</code></td><td><code>Bundle:patient</code>, <code>Composition:patient</code>, <code>DiagnosticReport:patient</code>, <code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#OperationDefinition1-5\">OperationDefinition</a></td><td><a href=\"http://hl7.org/fhir/R4/operationdefinition.html\">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></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><code>*</code></td><td><code>Bundle:patient</code>, <code>Composition:patient</code>, <code>DiagnosticReport:patient</code>, <code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#Patient1-6\">Patient</a></td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">http://hl7.org/fhir/StructureDefinition/Patient</a></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_lastUpdated, birthdate, identifier</td><td><code>*</code></td><td><code>Bundle:patient</code>, <code>Composition:patient</code>, <code>DiagnosticReport:patient</code>, <code>DocumentReference:patient</code></td><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Bundle</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=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</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>search-type</code>, <code>read</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>category</td><td><code>token</code></td><td><div><p>Study type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Date range for the search</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Patient business identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>specialty</td><td><code>token</code></td><td><div><p>Specialty</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>The type of the Document</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=\"Composition1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Composition</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=\"http://hl7.org/fhir/R4/composition.html\">Composition</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>search-type</code>, <code>read</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>category</td><td><code>token</code></td><td><div><p>Study type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Date range for the search</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Patient business identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>specialty</td><td><code>token</code></td><td><div><p>Specialty</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>The type of the Document</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$document</td><td><div/></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DiagnosticReport1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DiagnosticReport</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=\"http://hl7.org/fhir/R4/diagnosticreport.html\">DiagnosticReport</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>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>category</td><td><code>token</code></td><td><div><p>Study type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>contenttype</td><td><code>token</code></td><td><div><p>The type of the content</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Date range for the search</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Patient business identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>The type of the Document</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=\"DocumentReference1-4\" 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=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</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>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>category</td><td><code>token</code></td><td><div><p>Study type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>contenttype</td><td><code>token</code></td><td><div><p>The type of the content</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Date range for the search</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Patient business identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>The type of the Document</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=\"OperationDefinition1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>OperationDefinition</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=\"http://hl7.org/fhir/R4/operationdefinition.html\">OperationDefinition</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>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Patient</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=\"http://hl7.org/fhir/R4/patient.html\">Patient</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>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>_lastUpdated</td><td><code>date</code></td><td><div><p>Only return resources which were last updated as specified by the given range</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>The patient's date of birth</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>A patient identifier</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "http://myhealth.eu/fhir/ncp-api/CapabilityStatement/a87fce1b-c081-4667-a092-64834ab7e05b",
"version" : "0.0.1",
"name" : "RestServer",
"status" : "active",
"date" : "2024-06-27T10:58:29.763+00:00",
"publisher" : "MyHealthEu",
"contact" : [
{
"name" : "MyHealthEu",
"telecom" : [
{
"system" : "url",
"value" : "http://example.org/MyHealthEu"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "150",
"display" : "Europe"
}
]
}
],
"kind" : "instance",
"software" : {
"name" : "myHealth@EU",
"version" : "0.0.1",
"releaseDate" : "2024-01-01"
},
"implementation" : {
"description" : "myHealth@EU FHIR POC",
"url" : "/fhir"
},
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"xml",
"application/fhir+json",
"json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Bundle",
"profile" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"*",
"Bundle:patient"
],
"searchRevInclude" : [
"Bundle:patient",
"Composition:patient",
"DiagnosticReport:patient",
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Study type"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Date range for the search"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Patient business identifier"
},
{
"name" : "specialty",
"type" : "token",
"documentation" : "Specialty"
},
{
"name" : "type",
"type" : "token",
"documentation" : "The type of the Document"
}
]
},
{
"type" : "Composition",
"profile" : "http://hl7.org/fhir/StructureDefinition/Composition",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"*",
"Composition:patient"
],
"searchRevInclude" : [
"Bundle:patient",
"Composition:patient",
"DiagnosticReport:patient",
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Study type"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Date range for the search"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Patient business identifier"
},
{
"name" : "specialty",
"type" : "token",
"documentation" : "Specialty"
},
{
"name" : "type",
"type" : "token",
"documentation" : "The type of the Document"
}
],
"operation" : [
{
"name" : "document",
"definition" : "/fhir/OperationDefinition/Composition-i-document"
}
]
},
{
"type" : "DiagnosticReport",
"profile" : "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"interaction" : [
{
"code" : "search-type"
}
],
"searchInclude" : [
"*",
"DiagnosticReport:patient"
],
"searchRevInclude" : [
"Bundle:patient",
"Composition:patient",
"DiagnosticReport:patient",
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Study type"
},
{
"name" : "contenttype",
"type" : "token",
"documentation" : "The type of the content"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Date range for the search"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Patient business identifier"
},
{
"name" : "type",
"type" : "token",
"documentation" : "The type of the Document"
}
]
},
{
"type" : "DocumentReference",
"profile" : "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"interaction" : [
{
"code" : "search-type"
}
],
"searchInclude" : [
"*",
"DocumentReference:patient"
],
"searchRevInclude" : [
"Bundle:patient",
"Composition:patient",
"DiagnosticReport:patient",
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Study type"
},
{
"name" : "contenttype",
"type" : "token",
"documentation" : "The type of the content"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Date range for the search"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Patient business identifier"
},
{
"name" : "type",
"type" : "token",
"documentation" : "The type of the Document"
}
]
},
{
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"Bundle:patient",
"Composition:patient",
"DiagnosticReport:patient",
"DocumentReference:patient"
]
},
{
"type" : "Patient",
"profile" : "http://hl7.org/fhir/StructureDefinition/Patient",
"interaction" : [
{
"code" : "search-type"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"Bundle:patient",
"Composition:patient",
"DiagnosticReport:patient",
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Only return resources which were last updated as specified by the given range"
},
{
"name" : "birthdate",
"type" : "date",
"documentation" : "The patient's date of birth"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A patient identifier"
}
]
}
]
}
]
}
IG © 2023+ MyHealthEu. Package myhealth.eu.fhir.ncp-api#0.0.1 based on FHIR 4.0.1. Generated 2024-09-19
