XIG: CapabilityStatement/IHE.PMIR.PatientIdentityRegistry

FHIR IG Statistics: CapabilityStatement/IHE.PMIR.PatientIdentityRegistry

Package	ihe.iti.pmir
Type	CapabilityStatement
Id	IHE.PMIR.PatientIdentityRegistry
FHIR Version	R4
Source	https://profiles.ihe.net/ITI/PMIR/https://build.fhir.org/ig/IHE/ITI.PMIR/CapabilityStatement-IHE.PMIR.PatientIdentityRegistry.html
URL	https://profiles.ihe.net/ITI/PMIR/CapabilityStatement/IHE.PMIR.PatientIdentityRegistry
Version	1.5.1-current
Status	active
Date	2022-10-27
Name	IHE_PMIR_PatientIdentityRegistry
Title	IHE PMIR Patient Identity Registry
Realm	uv
Authority	ihe
Description	CapabilityStatement for the Patient Identity Registry Actor in the IHE IT Infrastructure Technical Framework Supplement [IHE PMIR](index.html).
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
IHE.PMIR.Subscription.Request	IHE Patient Master Identity Registry Subscription request

Narrative

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

Generated Narrative: CapabilityStatement IHE.PMIR.PatientIdentityRegistry

IHE PMIR Patient Identity Registry

Implementation Guide Version: 1.5.1-current
FHIR Version: 4.0.1
Supported Formats: application/fhir+xml, application/fhir+json
Supported Patch Formats:
Published on: 2022-10-27
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`

PMIR Patient Identity Registry provides capability to manage Master Patient Identity.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-on-FHIR

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	D	Searches	`_include`	`_revinclude`	Operations
Subscription	Supported Profiles IHE Patient Master Identity Registry Subscription request	y		y	y	y
Patient		y	y				_id, active, address-city, address-country, address-postalcode, address-state, birthdate, family, gender, given, identifier, telecom, _lastUpdated, mothersMaidenName			`$ihe-pix`

Resource Conformance: supported Subscription

Core FHIR Resource
Subscription

Reference Policy

Interaction summary

Supports create, read, update, delete.

Supported Profiles

IHE Patient Master Identity Registry Subscription request

Documentation

For Subscribe to Patient Updates [ITI-94]

Resource Conformance: supported Patient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

For Mobile Patient Identifier Cross-reference Query [ITI-83] and Mobile Patient Demographics Query [ITI-78]

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
SHALL	mothersMaidenName	`string`	Mother's maiden (unmarried) name, commonly collected to help verify patient identity.

Extended Operations

Conformance	Operation	Documentation
SHALL	$ihe-pix

FHIR Messaging Capabilities

Messaging Capability 1

Supported Message(s)

Mode	Definition
sender	`https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition`

Documentation

For Mobile Patient Identity Feed [ITI-93]

Messaging Capability 2

Supported Message(s)

Mode	Definition
receiver	`https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition`

Documentation

For Mobile Patient Identity Feed [ITI-93]

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.PMIR.PatientIdentityRegistry",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/PMIR/CapabilityStatement/IHE.PMIR.PatientIdentityRegistry",
  "version": "1.5.1-current",
  "name": "IHE_PMIR_PatientIdentityRegistry",
  "title": "IHE PMIR Patient Identity Registry",
  "status": "active",
  "experimental": false,
  "date": "2022-10-27",
  "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": "CapabilityStatement for the Patient Identity Registry Actor in the IHE IT Infrastructure Technical Framework Supplement [IHE PMIR](index.html).",
  "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": "PMIR Patient Identity Registry provides capability to manage Master Patient Identity.",
      "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-on-FHIR"
      },
      "resource": [
        {
          "type": "Subscription",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/PMIR/StructureDefinition/IHE.PMIR.Subscription.Request"
          ],
          "documentation": "For Subscribe to Patient Updates [ITI-94]",
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "read"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ]
        },
        {
          "type": "Patient",
          "documentation": "For Mobile Patient Identifier Cross-reference Query [ITI-83]\nand Mobile Patient Demographics Query [ITI-78]",
          "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"
            },
            {
              "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."
            }
          ],
          "operation": [
            {
              "name": "$ihe-pix",
              "definition": "https://profiles.ihe.net/ITI/PIXm/OperationDefinition/IHE_PIXm_pix"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ],
  "messaging": [
    {
      "documentation": "For Mobile Patient Identity Feed [ITI-93]",
      "supportedMessage": [
        {
          "mode": "sender",
          "definition": "https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition"
        }
      ]
    },
    {
      "documentation": "For Mobile Patient Identity Feed [ITI-93]",
      "supportedMessage": [
        {
          "mode": "receiver",
          "definition": "https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition"
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/IHE.PMIR.PatientIdentityRegistry

Resources that use this resource

Resources that this resource uses

Narrative

IHE PMIR Patient Identity Registry

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: supported Subscription

Resource Conformance: supported Patient

FHIR Messaging Capabilities

Messaging Capability 1

Supported Message(s)

Messaging Capability 2

Supported Message(s)

Source

Mode: `server`