Clinical Practice Guidelines
2.0.0-ballot - ballot International flag

This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

CapabilityStatement: CPG Common Patient Registry (Experimental)

Official URL: http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry Version: 2.0.0-ballot
Active as of 2023-08-04 Computable Name: CPGCommonPatientRegistry

Describes the expected set of functionality required for a patient registry service that supports the common registration process defined in this implementation guide.

Raw OpenAPI-Swagger Definition file | Download

CPG Common Patient Registry

  • Implementation Guide Version: 2.0.0-ballot
  • FHIR Version: 4.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: Fri Aug 04 00:00:00 UTC 2023
  • 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 TypeProfileRSUCSearches_include_revincludeOperations
Patient yyyyactive, birthdate, name, identifier

Resource Conformance: supportedPatient

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLactivetoken
SHALLbirthdatedate
SHALLnamestring
SHALLidentifiertoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$$match
SHALL$$summary