XIG: CapabilityStatement/CH.PDQm.Consumer

FHIR IG Statistics: CapabilityStatement/CH.PDQm.Consumer

Package	ch.fhir.ig.ch-epr-mhealth
Type	CapabilityStatement
Id	CH.PDQm.Consumer
FHIR Version	R4
Source	http://fhir.ch/ig/ch-epr-mhealth/http://fhir.ch/ig/ch-epr-mhealth/3.0.0/CapabilityStatement-CH.PDQm.Consumer.html
URL	http://fhir.ch/ig/ch-epr-mhealth/CapabilityStatement/CH.PDQm.Consumer
Version	3.0.0
Status	active
Date	2023-04-25
Name	CH_PDQm_Consumer
Title	PDQm Consumer (client)
Realm	ch
Authority	hl7
Description	CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE PDQm.
Copyright	CC0-1.0
Kind	requirements

Resources that use this resource

CapabilityStatement
CH.mHealth.App	mHealth: App (client)

Resources that this resource uses

StructureDefinition
ch-pdqm-patient	CH PDQm Patient

Narrative

Note: links and images are rebased to the (stated) source

PDQm Consumer (client)

Implementation Guide Version: 3.0.0
FHIR Version: 4.0.1
Supported Formats: application/fhir+xml, application/fhir+json
Supported Patch Formats:
Published on: Tue Apr 25 00:00:00 CEST 2023
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-system interaction.

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 Type	Profile	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Patient	Supported profiles: CH PDQm Patient	y	y			_id, active, address-city, address-country, address-postalcode, address-state, birthdate, family, gender, given, identifier, telecom, _lastUpdated

Resource Conformance: supportedPatient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

Supports read, search-type.

Supported Profiles

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

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	active	`token`	Whether the patient record is active
SHALL	address-city	`string`	A city specified in an address
SHALL	address-country	`string`	A country specified in an address
SHALL	address-postalcode	`string`	A postalCode specified in an address
SHALL	address-state	`string`	A state specified in an address
SHALL	birthdate	`date`	The patient's date of birth
SHALL	family	`string`	A portion of the family name of the patient
SHALL	gender	`token`	Gender of the patient
SHALL	given	`string`	A portion of the given name of the patient
SHALL	identifier	`token`	A patient identifier
SHALL	telecom	`token`	The value in any kind of telecom details of the patient
SHALL	_lastUpdated	`date`	When the resource version last changed

Source

{
  "resourceType": "CapabilityStatement",
  "id": "CH.PDQm.Consumer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ch/ig/ch-epr-mhealth/CapabilityStatement/CH.PDQm.Consumer",
  "version": "3.0.0",
  "name": "CH_PDQm_Consumer",
  "title": "PDQm Consumer (client)",
  "status": "active",
  "experimental": false,
  "date": "2023-04-25",
  "publisher": "eHealth Suisse",
  "contact": [
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE PDQm.",
  "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": "PDQm client will query for Patient resources matching a sub-set of the FHIR core Patient resource query parameters",
      "security": {
        "description": "TLS SHALL be used together with IUA basic access token"
      },
      "resource": [
        {
          "type": "Patient",
          "supportedProfile": [
            "http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-pdqm-patient"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "active",
              "type": "token",
              "documentation": "Whether the patient record is active"
            },
            {
              "name": "address-city",
              "type": "string",
              "documentation": "A city specified in an address"
            },
            {
              "name": "address-country",
              "type": "string",
              "documentation": "A country specified in an address"
            },
            {
              "name": "address-postalcode",
              "type": "string",
              "documentation": "A postalCode specified in an address"
            },
            {
              "name": "address-state",
              "type": "string",
              "documentation": "A state specified in an address"
            },
            {
              "name": "birthdate",
              "type": "date",
              "documentation": "The patient's date of birth"
            },
            {
              "name": "family",
              "type": "string",
              "documentation": "A portion of the family name of the patient"
            },
            {
              "name": "gender",
              "type": "token",
              "documentation": "Gender of the patient"
            },
            {
              "name": "given",
              "type": "string",
              "documentation": "A portion of the given name of the patient"
            },
            {
              "name": "identifier",
              "type": "token",
              "documentation": "A patient identifier"
            },
            {
              "name": "telecom",
              "type": "token",
              "documentation": "The value in any kind of telecom details of the patient"
            },
            {
              "name": "_lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}