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

CapabilityStatement: RestServer

Official URL: http://myhealth.eu/fhir/ncp-api/CapabilityStatement/a87fce1b-c081-4667-a092-64834ab7e05b Version: 0.0.1
Active as of 2024-06-27 Computable Name: RestServer

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement a87fce1b-c081-4667-a092-64834ab7e05b

  • Implementation Guide Version: 0.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json
  • Supported Patch Formats:
  • Published on: 2024-06-27 10:58:29+0000
  • Published by: MyHealthEu

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: server

Summary of System-wide Interactions

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 TypeProfileRSUCSearches_include_revincludeOperations
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyycategory, date, patient, specialty, type*, Bundle:patientBundle:patient, Composition:patient, DiagnosticReport:patient, DocumentReference:patient
Compositionhttp://hl7.org/fhir/StructureDefinition/Compositionyycategory, date, patient, specialty, type*, Composition:patientBundle:patient, Composition:patient, DiagnosticReport:patient, DocumentReference:patient$document
DiagnosticReporthttp://hl7.org/fhir/StructureDefinition/DiagnosticReportycategory, contenttype, date, patient, type*, DiagnosticReport:patientBundle:patient, Composition:patient, DiagnosticReport:patient, DocumentReference:patient
DocumentReferencehttp://hl7.org/fhir/StructureDefinition/DocumentReferenceycategory, contenttype, date, patient, type*, DocumentReference:patientBundle:patient, Composition:patient, DiagnosticReport:patient, DocumentReference:patient
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*Bundle:patient, Composition:patient, DiagnosticReport:patient, DocumentReference:patient
Patienthttp://hl7.org/fhir/StructureDefinition/Patienty_lastUpdated, birthdate, identifier*Bundle:patient, Composition:patient, DiagnosticReport:patient, DocumentReference:patient

Resource Conformance: supported Bundle

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLspecialtytoken

Specialty

SHALLtypetoken

The type of the Document

 

Resource Conformance: supported Composition

Base System Profile
Composition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLspecialtytoken

Specialty

SHALLtypetoken

The type of the Document

 
Extended Operations
ConformanceOperationDocumentation
SHALL$document

Resource Conformance: supported DiagnosticReport

Base System Profile
DiagnosticReport
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLcontenttypetoken

The type of the content

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLtypetoken

The type of the Document

 

Resource Conformance: supported DocumentReference

Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLcontenttypetoken

The type of the content

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLtypetoken

The type of the Document

 

Resource Conformance: supported OperationDefinition

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALLbirthdatedate

The patient's date of birth

SHALLidentifiertoken

A patient identifier