XIG: CapabilityStatement/toc

FHIR IG Statistics: CapabilityStatement/toc

Package	hl7.fhir.us.pacio-toc
Type	CapabilityStatement
Id	toc
FHIR Version	R4
Source	http://hl7.org/fhir/us/pacio-toc/https://build.fhir.org/ig/HL7/fhir-transitions-of-care-ig/CapabilityStatement-toc.html
URL	http://hl7.org/fhir/us/pacio-toc/CapabilityStatement/toc
Version	1.0.0-ballot
Status	active
Date	2023-11-10
Name	PacioTocCapabilityStatement
Title	TOC CapabilityStatement
Realm	us
Authority	hl7
Description	This Section describes the expected capabilities of the PACIO Transitions of Care (TOC) Server actor which is responsible for providing responses to the queries submitted by the TOC Requestors. The TOC information is conveyed via a Bundle.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

SearchParameter
us-core-ethnicity	USCoreEthnicity
us-core-patient-family	USCorePatientFamily
us-core-patient-given	USCorePatientGiven
us-core-patient-id	USCorePatientId
us-core-patient-identifier	USCorePatientIdentifier
us-core-patient-name	USCorePatientName
us-core-race	USCoreRace

Narrative

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

Generated Narrative: CapabilityStatement toc

TOC CapabilityStatement

Implementation Guide Version: 1.0.0-ballot
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats: application/json-patch+json
Published on: 2023-11-10
Published by: HL7 International / Patient Care

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.

SHALL Support the Following Implementation Guides

https://build.fhir.org/ig/HL7/pacio-toc/ImplementationGuide-hl7.fhir.us.pacio-toc

FHIR RESTful Capabilities

Mode: `server`

The TOC Server SHALL:

Support all profiles defined in this Implementation Guide.
Implement the RESTful behavior according to the FHIR specification.
Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
- (Status 410): deleted resource.
Support json source formats for all TOC interactions.
Support the searchParameters on each profile individually and in combination.

The TOC Server SHOULD:

Support xml source formats for all TOC interactions.

Security

See the Guidance section for requirements and recommendations.

A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code.

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	V-R	S	U	C	H-I	Searches	Operations
Bundle		y	y	y	y	y	y	_id, composition, identifier, timestamp, type
Composition	Supported Profiles `https://hl7.org/fhir/us/pacio-toc/StructureDefinition-TOC-Composition-Header.html`	y	y	y	y	y	y
Organization		y	y	y	y	y	y
Patient	Supported Profiles `https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html\|6.1.0`	y	y	y	y	y	y	_id, active, address, address-city, address-country, address-postalcode, address-state, address-use, birthdate, death-date, deceased, email, family, gender, general-practitioner, given, identifier, language, link, name, organization, phone, phonetic, telecom, race, ethnicity
OperationDefinition	https://hl7.org/fhir/R4/patient-operation-match.html								`$match`

Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle

Reference Policy
resolves

Interaction summary

SHALL support create, read, update.
SHOULD support search-type, vread, history-instance.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	composition	`reference`
SHOULD	identifier	`token`
SHOULD	timestamp	`date`
SHOULD	type	`token`

Resource Conformance: MAY Composition

Core FHIR Resource
Composition

Reference Policy
resolves

Interaction summary

SHOULD support vread, history-instance.
MAY support create, search-type, read, update.

Supported Profiles

https://hl7.org/fhir/us/pacio-toc/StructureDefinition-TOC-Composition-Header.html

Resource Conformance: SHALL Organization

Core FHIR Resource
Organization

Reference Policy
resolves

Interaction summary

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Resource Conformance: MAY Patient

Core FHIR Resource
Patient

Reference Policy
resolves

Interaction summary

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Supported Profiles

https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html|6.1.0

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-id.html
SHALL	birthdate	`date`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html
SHALL	family	`string`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html
SHALL	gender	`token`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html
SHALL	given	`string`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html
SHALL	identifier	`token`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-identifier.html
SHALL	name	`string`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html
SHOULD	active	`token`
SHOULD	email	`token`
SHOULD	phone	`token`
SHOULD	telecom	`token`
MAY	address	`string`
MAY	address-city	`string`
MAY	address-country	`string`
MAY	address-postalcode	`string`
MAY	address-state	`string`
MAY	address-use	`token`
MAY	death-date	`date`
MAY	deceased	`token`
MAY	general-practitioner	`reference`
MAY	language	`token`
MAY	link	`reference`
MAY	organization	`reference`
MAY	phonetic	`string`
MAY	race	`token`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html
MAY	ethnicity	`token`	https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html

Resource Conformance: supported OperationDefinition

Base System Profile
https://hl7.org/fhir/R4/patient-operation-match.html

Profile Conformance
SHALL

Reference Policy

Interaction summary

Extended Operations

Conformance	Operation	Documentation
SHALL	$match	$match is a service used to manage patient identification in a context where multiple patient databases exist.To ask an MPI to match a patient, clients use the '$match' operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "toc",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pc"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/pacio-toc/ImplementationGuide/hl7.fhir.us.pacio-toc"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/pacio-toc/ImplementationGuide/hl7.fhir.us.pacio-toc"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/pacio-toc/CapabilityStatement/toc",
  "version": "1.0.0-ballot",
  "name": "PacioTocCapabilityStatement",
  "title": "TOC CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2023-11-10",
  "publisher": "HL7 International / Patient Care",
  "contact": [
    {
      "name": "HL7 International / Patient Care",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/patientcare"
        },
        {
          "system": "email",
          "value": "patientcare@lists.HL7.org"
        }
      ]
    },
    {
      "name": "PACIO project",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/patientcare"
        },
        {
          "system": "email",
          "value": "info@pacioproject.org"
        }
      ]
    }
  ],
  "description": "This Section describes the expected capabilities of the PACIO Transitions of Care (TOC) Server actor which is responsible for providing responses to the queries submitted by the TOC Requestors. \n\nThe TOC information is conveyed via a Bundle.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "https://build.fhir.org/ig/HL7/pacio-toc/ImplementationGuide-hl7.fhir.us.pacio-toc"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "The TOC Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide.\n2.  Implement the RESTful behavior according to the FHIR specification.\n3. Return the following response classes:\n   - (Status 400): invalid parameter\n   - (Status 401/4xx): unauthorized request\n   - (Status 403): insufficient scope\n   - (Status 404): unknown resource\n   - (Status 410): deleted resource.\n4. Support json source formats for all TOC interactions.\n5. Support the searchParameters on each profile  individually and in combination.\n\nThe TOC Server **SHOULD**:\n\n1. Support xml source formats for all TOC interactions.",
      "security": {
        "description": "1. See the [Guidance](security_privacy_consent.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an HTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\" response code."
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Bundle",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "search-type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "history-instance"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "composition",
              "definition": "http://hl7.org/fhir/SearchParameter/Bundle-composition",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Bundle-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "timestamp",
              "definition": "http://hl7.org/fhir/SearchParameter/Bundle-timestamp",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/Bundle-type",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "type": "Composition",
          "supportedProfile": [
            "https://hl7.org/fhir/us/pacio-toc/StructureDefinition-TOC-Composition-Header.html"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "search-type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "history-instance"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Organization",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "history-instance"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "type": "Patient",
          "supportedProfile": [
            "https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html|6.1.0"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "history-instance"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id|6.1.0",
              "type": "token",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-id.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-active",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "address-city",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "address-country",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-country",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "address-postalcode",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "address-state",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "address-use",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-use",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "birthdate",
              "definition": "https://build.fhir.org/ig/HL7/pacio-toc/SearchParameter/patient-birthdate",
              "type": "date",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "death-date",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-death-date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "deceased",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-deceased",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "email",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-email",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "family",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family|6.1.0",
              "type": "string",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "gender",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender|6.1.0",
              "type": "token",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "general-practitioner",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "given",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given|6.1.0",
              "type": "string",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier|6.1.0",
              "type": "token",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-identifier.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "language",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-language",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "link",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-link",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name|6.1.0",
              "type": "string",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "organization",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-organization",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "phone",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-phone",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "phonetic",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-phonetic",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "telecom",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "race",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-race|6.1.0",
              "type": "token",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "ethnicity",
              "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-ethnicity|6.1.0",
              "type": "token",
              "documentation": "https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html"
            }
          ]
        },
        {
          "type": "OperationDefinition",
          "profile": "https://hl7.org/fhir/R4/patient-operation-match.html",
          "operation": [
            {
              "name": "$match",
              "definition": "https://hl7.org/fhir/R4/patient-operation-match.html",
              "documentation": "$match is a service used to manage patient identification in a context where multiple patient databases exist.To ask an MPI to match a patient, clients use the '$match' operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set."
            }
          ]
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/toc

Resources that use this resource

Resources that this resource uses

Narrative

TOC CapabilityStatement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Bundle

Resource Conformance: MAY Composition

Resource Conformance: SHALL Organization

Resource Conformance: MAY Patient

Resource Conformance: supported OperationDefinition

Source

Mode: `server`