XIG: CapabilityStatement/IHE.PDQm.PatientDemographicsSupplier

FHIR IG Statistics: CapabilityStatement/IHE.PDQm.PatientDemographicsSupplier

Package	ihe.iti.pdqm
Type	CapabilityStatement
Id	IHE.PDQm.PatientDemographicsSupplier
FHIR Version	R4
Source	https://profiles.ihe.net/ITI/PDQm/https://build.fhir.org/ig/IHE/ITI.PDQm/CapabilityStatement-IHE.PDQm.PatientDemographicsSupplier.html
URL	https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsSupplier
Version	3.1.1-current
Status	active
Date	2023-09-25
Name	IHE_PDQM_PATIENT_DEMOGRAPHICS_SUPPLIER
Title	IHE PDQm Patient Demographics Supplier
Realm	uv
Authority	ihe
Description	The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtyStatement expresses the requirements that SHALL be provided. - Query against the FHIR endpoint to the Patient Resource endpoint - Using FHIR R4 - SHALL support both json or xml encoding - SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/) - [Search Parameters that SHALL be supported](ITI-78.html#23784121-search-parameters) - _id - active - family - given - identifier - telecom - birthdate - address - gender - mothersMaidenName - SHALL support the `:exact` modifier on search parameters of type string - SHALL return Patient Resources conforming to the PDQm Patient Profile
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
IHE.PDQm.Patient	PDQm Patient Profile
IHE.PDQm.Patient	PDQm Patient Profile

Narrative

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

Generated Narrative: CapabilityStatement IHE.PDQm.PatientDemographicsSupplier

IHE PDQm Patient Demographics Supplier

Implementation Guide Version: 3.1.1-current
FHIR Version: 4.0.1
Supported Formats: application/fhir+xml, application/fhir+json
Supported Patch Formats:
Published on: 2023-09-25
Published by: IHE IT Infrastructure Technical Committee

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`

PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

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

Resource Conformance: supported Patient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

Supports read, search-type.

Supported Profiles

PDQm Patient Profile

Documentation

Mobile Patient Demographics Query [ITI-78]

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_lastUpdated	`date`	When the resource version last changed
SHALL	_id	`token`	Logical id of this artifact
SHALL	active	`token`	Whether the patient record is active
SHALL	family	`string`	A portion of the family name of the patient
SHALL	family:exact	`string`	A portion of the family name of the patient, modified to use exact string matching
SHALL	given	`string`	A portion of the given name of the patient
SHALL	given:exact	`string`	A portion of the given name of the patient, modified to use exact string matching
SHALL	identifier	`token`	A patient identifier
SHALL	telecom	`token`	The value in any kind of telecom details of the patient
SHALL	birthdate	`date`	The patient's date of birth
SHALL	address	`string`	A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
SHALL	address:exact	`string`	A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text, modified to use exact string matching
SHALL	address-city	`string`	A city specified in an address
SHALL	address-city:exact	`string`	A city specified in an address, modified to use exact string matching
SHALL	address-country	`string`	A country specified in an address
SHALL	address-country:exact	`string`	A country specified in an address, modified to use exact string matching
SHALL	address-postalcode	`string`	A postalCode specified in an address
SHALL	address-postalcode:exact	`string`	A postalCode specified in an address, modified to use exact string matching
SHALL	address-state	`string`	A state specified in an address
SHALL	address-state:exact	`string`	A state specified in an address, modified to use exact matching
SHALL	gender	`token`	Gender of the patient
SHALL	mothersMaidenName	`string`	Mother's maiden (unmarried) name, commonly collected to help verify patient identity.
SHALL	mothersMaidenName:exact	`string`	Mother's maiden (unmarried) name, commonly collected to help verify patient identity, modified to use exact string matching.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.PDQm.PatientDemographicsSupplier",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsSupplier",
  "version": "3.1.1-current",
  "name": "IHE_PDQM_PATIENT_DEMOGRAPHICS_SUPPLIER",
  "title": "IHE PDQm Patient Demographics Supplier",
  "status": "active",
  "experimental": false,
  "date": "2023-09-25",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    },
    {
      "name": "IHE IT Infrastructure Technical Committee",
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    }
  ],
  "description": "The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtyStatement expresses the requirements that SHALL be provided.\n\n- Query against the FHIR endpoint to the Patient Resource endpoint\n- Using FHIR R4\n- SHALL support both json or xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- [Search Parameters that SHALL be supported](ITI-78.html#23784121-search-parameters)\n  - _id\n  - active\n  - family\n  - given\n  - identifier\n  - telecom\n  - birthdate\n  - address\n  - gender\n  - mothersMaidenName\n- SHALL support the `:exact` modifier on search parameters of type string\n- SHALL return Patient Resources conforming to the PDQm Patient Profile",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities.",
      "security": {
        "description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource": [
        {
          "type": "Patient",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.Patient"
          ],
          "documentation": "Mobile Patient Demographics Query [ITI-78]",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "_id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "active",
              "type": "token",
              "documentation": "Whether the patient record is active"
            },
            {
              "name": "family",
              "type": "string",
              "documentation": "A portion of the family name of the patient"
            },
            {
              "name": "family:exact",
              "type": "string",
              "documentation": "A portion of the family name of the patient, modified to use exact string matching"
            },
            {
              "name": "given",
              "type": "string",
              "documentation": "A portion of the given name of the patient"
            },
            {
              "name": "given:exact",
              "type": "string",
              "documentation": "A portion of the given name of the patient, modified to use exact string matching"
            },
            {
              "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": "birthdate",
              "type": "date",
              "documentation": "The patient's date of birth"
            },
            {
              "name": "address",
              "type": "string",
              "documentation": "A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
            },
            {
              "name": "address:exact",
              "type": "string",
              "documentation": "A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text, modified to use exact string matching"
            },
            {
              "name": "address-city",
              "type": "string",
              "documentation": "A city specified in an address"
            },
            {
              "name": "address-city:exact",
              "type": "string",
              "documentation": "A city specified in an address, modified to use exact string matching"
            },
            {
              "name": "address-country",
              "type": "string",
              "documentation": "A country specified in an address"
            },
            {
              "name": "address-country:exact",
              "type": "string",
              "documentation": "A country specified in an address, modified to use exact string matching"
            },
            {
              "name": "address-postalcode",
              "type": "string",
              "documentation": "A postalCode specified in an address"
            },
            {
              "name": "address-postalcode:exact",
              "type": "string",
              "documentation": "A postalCode specified in an address, modified to use exact string matching"
            },
            {
              "name": "address-state",
              "type": "string",
              "documentation": "A state specified in an address"
            },
            {
              "name": "address-state:exact",
              "type": "string",
              "documentation": "A state specified in an address, modified to use exact matching"
            },
            {
              "name": "gender",
              "type": "token",
              "documentation": "Gender of the patient"
            },
            {
              "name": "mothersMaidenName",
              "definition": "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName",
              "type": "string",
              "documentation": "Mother's maiden (unmarried) name, commonly collected to help verify patient identity."
            },
            {
              "name": "mothersMaidenName:exact",
              "definition": "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName",
              "type": "string",
              "documentation": "Mother's maiden (unmarried) name, commonly collected to help verify patient identity, modified to use exact string matching."
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}