XIG: CapabilityStatement/cpg-common-patient-registry

FHIR IG Statistics: CapabilityStatement/cpg-common-patient-registry

Package	hl7.fhir.uv.cpg
Type	CapabilityStatement
Id	cpg-common-patient-registry
FHIR Version	R4
Source	http://hl7.org/fhir/uv/cpg/https://build.fhir.org/ig/HL7/cqf-recommendations/CapabilityStatement-cpg-common-patient-registry.html
URL	http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry
Version	2.0.0
Status	active
Date	2023-12-11
Name	CPGCommonPatientRegistry
Title	CPG Common Patient Registry
Realm	uv
Authority	hl7
Description	Describes the expected set of functionality required for a patient registry service that supports the common registration process defined in this implementation guide.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
cpg-common-patient-summary	CPG Common Patient Summary

Narrative

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

Generated Narrative: CapabilityStatement cpg-common-patient-registry

CPG Common Patient Registry

Implementation Guide Version: 2.0.0
FHIR Version: 4.0.0
Supported Formats: xml, json
Supported Patch Formats:
Published on: 2023-12-11
Published by: HL7 International / Clinical Decision Support

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`

Summary of System-wide Interactions

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		y	y	y	y	active, birthdate, name, identifier			`$match`, `$summary`

Resource Conformance: supported Patient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

Supports read, update, create, search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	active	`token`
SHALL	birthdate	`date`
SHALL	name	`string`
SHALL	identifier	`token`

Extended Operations

Conformance	Operation	Documentation
SHALL	$match
SHALL	$summary

Source

{
  "resourceType": "CapabilityStatement",
  "id": "cpg-common-patient-registry",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    }
  ],
  "url": "http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry",
  "version": "2.0.0",
  "name": "CPGCommonPatientRegistry",
  "title": "CPG Common Patient Registry",
  "status": "active",
  "experimental": true,
  "date": "2023-12-11",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "name": "HL7 International / Clinical Decision Support",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "Describes the expected set of functionality required for a patient registry service that supports the common registration process defined in this implementation guide.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.0",
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "Patient",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "update"
            },
            {
              "code": "create"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "active",
              "type": "token"
            },
            {
              "name": "birthdate",
              "type": "date"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "identifier",
              "type": "token"
            }
          ],
          "operation": [
            {
              "name": "$match",
              "definition": "http://hl7.org/fhir/OperationDefinition/Patient-match"
            },
            {
              "name": "$summary",
              "definition": "http://hl7.org/fhir/uv/cpg/OperationDefinition/cpg-common-patient-summary"
            }
          ]
        }
      ]
    }
  ]
}