{ "resourceType" : "CapabilityStatement", "id" : "CapabilityStatementMyHealthEuClient", "text" : { "status" : "extensions", "div" : "

Generated Narrative: CapabilityStatement CapabilityStatementMyHealthEuClient

CapabilityStatement: myHealth@EU Requesting NCPeH

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

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

Resource TypeProfileRSUCSearches_include_revincludeOperations
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryy
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyyidentifier, patient*, Bundle:patientDocumentReference:patient
DocumentReferencehttp://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheuyyy_id, category, contenttype, creation, date, patient, patient.identifier, period, status, type, modality, bodysite*, DocumentReference:patientDocumentReference:patient
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles:
\u00a0\u00a0Patient: Minimal		yyidentifier, name, _lastUpdated, birthdate, gender*DocumentReference:patient
ImagingStudyhttp://hl7.org/fhir/StructureDefinition/ImagingStudyyypatient, basedon, patient.identifier, modality, bodysite, identifier, started*, ImagingStudy:patient
MedicationRequesthttp://hl7.org/fhir/StructureDefinition/MedicationRequestyyidentifier, patient, patient.identifier, status, authoredon, medication
MedicationDispensehttp://hl7.org/fhir/StructureDefinition/MedicationDispensey
Immunizationhttp://hl7.org/fhir/StructureDefinition/Immunizationyystatus, date, patient, patient.identifier, vaccine-code, target-disease

Resource Conformance: unspecified Binary

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Documentation

Used to fetch a document representation whose content type is not application/fhir+json or application/fhir+xml

\n

Resource Conformance: unspecified Bundle

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Business identifier of the collection Bundle, equal to the business identifier of the MedicationRequest it groups

\n
SHALLpatientreference

Patient business identifier

\n
\u00a0

Resource Conformance: unspecified DocumentReference

Base System Profile
DocumentReference: Minimal
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

\n
SHALLcategorytoken

Categorization of document (Document Class)

\n
SHALLcontenttypetoken

Type of content / format (mime type of the document content)

\n
SHALLcreationdate

When this document was created

\n
SHALLpatientreference

Who/what is the subject of the document

\n
SHALLpatient.identifiertoken

An Identifier for Who/what is the subject of the document

\n
SHOULDdatedate

When this document reference was created

\n
SHOULDperioddate

Time of service that is being documented

\n
SHOULDstatustoken

current | superseded | entered-in-error

\n
SHOULDtypereference

Kind of document (LOINC if possible)

\n
SHOULDmodalitytoken

Search based on the modality associated with the document.

\n
SHOULDbodysitetoken

Search based on the anatomical region or body site associated with the document.

\n
\u00a0

Resource Conformance: unspecified Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Patient: Minimal

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_lastUpdateddate

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

\n
SHALLidentifiertoken

A patient identifier

\n
SHALLnamestring

A patient name

\n
SHALLbirthdatedate

The patient’s date of birth

\n
SHALLgendertoken

The patient’s gender

\n
\u00a0

Resource Conformance: unspecified ImagingStudy

Base System Profile
ImagingStudy
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient imaged in the study

\n
SHALLpatient.identifiertoken

An identifier for the patient imaged in the study (chained parameter)

\n
SHALLmodalitytoken

The modality of the series (e.g., CT, MR)

\n
SHALLbodysitetoken

The body site code studied

\n
SHALLidentifiertoken

Identifying value for the study

\n
SHALLstarteddate

Date/time when the study started

\n
SHOULDbasedonreference

The order for the image, such as Accession Number associated with a ServiceRequest

\n
\u00a0

Resource Conformance: unspecified MedicationRequest

Base System Profile
MedicationRequest
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Patient business identifier

\n
SHALLpatient.identifiertoken

An identifier for the patient the prescription is for (chained parameter)

\n
SHALLauthoredondate

The date the prescription was initially authored

\n
SHOULDidentifiertoken

Prescription business identifier. Used to identify the prescription item and to retrieve the corresponding collection Bundle

\n
SHOULDstatustoken

Used to search available or active prescriptions where supported

\n
MAYmedicationreference

Used when the requestor needs to filter by prescribed medication

\n
\u00a0

Resource Conformance: unspecified MedicationDispense

Base System Profile
MedicationDispense
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update.

Resource Conformance: unspecified Immunization

Base System Profile
Immunization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLstatustoken

Immunization event status

\n
SHALLdatedate

Vaccination (non)-Administration Date

\n
SHALLpatientreference

The patient for the vaccination record

\n
SHALLpatient.identifiertoken

An identifier for the patient the vaccination record is for (chained parameter)

\n
SHOULDvaccine-codetoken

Vaccine Product Administered

\n
MAYtarget-diseasetoken

The target disease the dose is being administered against

\n
\u00a0
" }, "url" : "http://fhir.ehdsi.eu/ncp-api/CapabilityStatement/CapabilityStatementMyHealthEuClient", "version" : "10.0.0-ci", "name" : "MyHealthEuNcpClientCapability", "title" : "CapabilityStatement: myHealth@EU Requesting NCPeH", "status" : "active", "date" : "2026-08-27", "publisher" : "MyHealthEu", "contact" : [{ "name" : "MyHealthEu", "telecom" : [{ "system" : "url", "value" : "http://example.org/MyHealthEu" }] }], "description" : "Describes the requirements that a myHealth@EU NCPeH FHIR client (Requesting NCP) SHALL, SHOULD, or MAY meet to be conformant with this guide. See the [RequestingNCP](ActorDefinition-RequestingNCP.html) actor definition; the companion server-side requirements are described in [CapabilityStatement: myHealth@EU Responding NCPeH](CapabilityStatement-CapabilityStatementMyHealthEu.html), for the [RespondingNCP](ActorDefinition-RespondingNCP.html) actor.", "jurisdiction" : [{ "coding" : [{ "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "150", "display" : "Europe" }] }], "kind" : "requirements", "fhirVersion" : "4.0.1", "format" : ["application/fhir+xml", "application/fhir+json"], "rest" : [{ "mode" : "client", "resource" : [{ "type" : "Binary", "profile" : "http://hl7.org/fhir/StructureDefinition/Binary", "documentation" : "Used to fetch a document representation whose content type is not application/fhir+json or application/fhir+xml", "interaction" : [{ "code" : "read" }] }, { "type" : "Bundle", "profile" : "http://hl7.org/fhir/StructureDefinition/Bundle", "interaction" : [{ "code" : "search-type" }, { "code" : "read" }, { "code" : "create" }], "searchInclude" : ["*", "Bundle:patient"], "searchRevInclude" : ["DocumentReference:patient"], "searchParam" : [{ "name" : "identifier", "type" : "token", "documentation" : "Business identifier of the collection Bundle, equal to the business identifier of the MedicationRequest it groups" }, { "name" : "patient", "type" : "reference", "documentation" : "Patient business identifier" }] }, { "type" : "DocumentReference", "profile" : "http://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu", "interaction" : [{ "code" : "search-type" }, { "code" : "read" }, { "code" : "create" }], "searchInclude" : ["*", "DocumentReference:patient"], "searchRevInclude" : ["DocumentReference:patient"], "searchParam" : [{ "name" : "_id", "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id", "type" : "token", "documentation" : "Logical id of this artifact" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "category", "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category", "type" : "token", "documentation" : "Categorization of document (Document Class)" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "contenttype", "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype", "type" : "token", "documentation" : "Type of content / format (mime type of the document content)" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "creation", "definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation", "type" : "date", "documentation" : "When this document was created" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "date", "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date", "type" : "date", "documentation" : "When this document reference was created" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "patient", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient", "type" : "reference", "documentation" : "Who/what is the subject of the document" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "patient.identifier", "type" : "token", "documentation" : "An Identifier for Who/what is the subject of the document" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "period", "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period", "type" : "date", "documentation" : "Time of service that is being documented" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "status", "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status", "type" : "token", "documentation" : "current | superseded | entered-in-error" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "type", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient", "type" : "reference", "documentation" : "Kind of document (LOINC if possible)" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "modality", "definition" : "http://fhir.ehdsi.eu/ncp-api/SearchParameter/DocumentReference-modality", "type" : "token", "documentation" : "Search based on the modality associated with the document." }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "bodysite", "definition" : "http://fhir.ehdsi.eu/ncp-api/SearchParameter/DocumentReference-bodysite", "type" : "token", "documentation" : "Search based on the anatomical region or body site associated with the document." }] }, { "type" : "Patient", "profile" : "http://hl7.org/fhir/StructureDefinition/Patient", "supportedProfile" : ["http://fhir.ehdsi.eu/ncp-api/StructureDefinition/Patient-minimal-myhealtheu"], "interaction" : [{ "code" : "search-type" }, { "code" : "read" }], "searchInclude" : ["*"], "searchRevInclude" : ["DocumentReference:patient"], "searchParam" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "identifier", "type" : "token", "documentation" : "A patient identifier" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "name", "type" : "string", "documentation" : "A patient name" }, { "name" : "_lastUpdated", "type" : "date", "documentation" : "Only return resources which were last updated as specified by the given range" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "birthdate", "type" : "date", "documentation" : "The patient’s date of birth" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "gender", "type" : "token", "documentation" : "The patient’s gender" }] }, { "type" : "ImagingStudy", "profile" : "http://hl7.org/fhir/StructureDefinition/ImagingStudy", "interaction" : [{ "code" : "search-type" }, { "code" : "read" }], "searchInclude" : ["*", "ImagingStudy:patient"], "searchParam" : [{ "name" : "patient", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient", "type" : "reference", "documentation" : "The patient imaged in the study" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "basedon", "definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-basedon", "type" : "reference", "documentation" : "The order for the image, such as Accession Number associated with a ServiceRequest" }, { "name" : "patient.identifier", "type" : "token", "documentation" : "An identifier for the patient imaged in the study (chained parameter)" }, { "name" : "modality", "definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality", "type" : "token", "documentation" : "The modality of the series (e.g., CT, MR)" }, { "name" : "bodysite", "definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite", "type" : "token", "documentation" : "The body site code studied" }, { "name" : "identifier", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type" : "token", "documentation" : "Identifying value for the study" }, { "name" : "started", "definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-started", "type" : "date", "documentation" : "Date/time when the study started" }] }, { "type" : "MedicationRequest", "profile" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "interaction" : [{ "code" : "search-type" }, { "code" : "read" }], "searchParam" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "identifier", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier", "type" : "token", "documentation" : "Prescription business identifier. Used to identify the prescription item and to retrieve the corresponding collection Bundle" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "patient", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient", "type" : "reference", "documentation" : "Patient business identifier" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "patient.identifier", "type" : "token", "documentation" : "An identifier for the patient the prescription is for (chained parameter)" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "status", "definition" : "http://hl7.org/fhir/SearchParameter/medications-status", "type" : "token", "documentation" : "Used to search available or active prescriptions where supported" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "authoredon", "definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon", "type" : "date", "documentation" : "The date the prescription was initially authored" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "MAY" }], "name" : "medication", "definition" : "http://hl7.org/fhir/SearchParameter/medications-medication", "type" : "reference", "documentation" : "Used when the requestor needs to filter by prescribed medication" }] }, { "type" : "MedicationDispense", "profile" : "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "interaction" : [{ "code" : "update" }], "conditionalUpdate" : true }, { "type" : "Immunization", "profile" : "http://hl7.org/fhir/StructureDefinition/Immunization", "interaction" : [{ "code" : "search-type" }, { "code" : "read" }], "searchParam" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "status", "definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status", "type" : "token", "documentation" : "Immunization event status" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "date", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-date", "type" : "date", "documentation" : "Vaccination (non)-Administration Date" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "patient", "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient", "type" : "reference", "documentation" : "The patient for the vaccination record" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHALL" }], "name" : "patient.identifier", "type" : "token", "documentation" : "An identifier for the patient the vaccination record is for (chained parameter)" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "SHOULD" }], "name" : "vaccine-code", "definition" : "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code", "type" : "token", "documentation" : "Vaccine Product Administered" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode" : "MAY" }], "name" : "target-disease", "definition" : "http://hl7.org/fhir/SearchParameter/Immunization-target-disease", "type" : "token", "documentation" : "The target disease the dose is being administered against" }] }] }] }