CH EPR FHIR (R4)
4.0.1-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot: DSTU 4 Ballot 2) 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

CapabilityStatement: PDQm Consumer (client)

Official URL: http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.PDQm.Consumer Version: 4.0.1-ballot
Active as of 2023-04-25 Computable Name: CH_PDQm_Consumer

Copyright/Legal: CC0-1.0

CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE PDQm.

Raw OpenAPI-Swagger Definition file | Download

PDQm Consumer (client)

  • Implementation Guide Version: 4.0.1-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2023-04-25
  • Published by: eHealth Suisse

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

PDQm client will query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters

Security

TLS SHALL be used together with IUA basic access token

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

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
PatientSupported Profiles
  CH PDQm Patient		yy_id, active, address-city, address-country, address-postalcode, address-state, birthdate, family, gender, given, identifier, telecom, _lastUpdated

Resource Conformance: supported Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-pdqm-patient

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLactivetoken

Whether the patient record is active

SHALLaddress-citystring

A city specified in an address

SHALLaddress-countrystring

A country specified in an address

SHALLaddress-postalcodestring

A postalCode specified in an address

SHALLaddress-statestring

A state specified in an address

SHALLbirthdatedate

The patient's date of birth

SHALLfamilystring

A portion of the family name of the patient

SHALLgendertoken

Gender of the patient

SHALLgivenstring

A portion of the given name of the patient

SHALLidentifiertoken

A patient identifier

SHALLtelecomtoken

The value in any kind of telecom details of the patient

SHALL_lastUpdateddate

When the resource version last changed