FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/PatientCorrectionCapability

Packagehl7.fhir.uv.patient-corrections
TypeCapabilityStatement
IdPatientCorrectionCapability
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/patient-corrections/https://build.fhir.org/ig/HL7/fhir-patient-correction/CapabilityStatement-PatientCorrectionCapability.html
URLhttp://hl7.org/fhir/uv/patient-corrections/CapabilityStatement/PatientCorrectionCapability
Version1.0.0
Statusactive
Date2022-03-04
NamePatientCorrectionCapability
TitlePatient Request for Corrections Capability Statement
Realmuv
Authorityhl7
DescriptionDescribes the capabilities for a FHIR server to support patient requests for corrections.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.uv.patient-correctionsPatient Request for Corrections Implementation Guide

Narrative

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

Generated Narrative: CapabilityStatement PatientCorrectionCapability

Patient Request for Corrections Capability Statement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2022-03-04
  • Published by: HL7 International / Patient Empowerment

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

FHIR RESTful Capabilities

Mode: server

Description of the needed resources to be supported by the FHIR server, and the different possible interactions.

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • 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 TypeProfileRSUCSearches_include_revincludeOperations
Communication yyabout
Task yyreasonReference
Bundle y

Resource Conformance: SHALL Communication

Core FHIR Resource
Communication
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Documentation

Read a communication between a patient and a fulfiller relating to a patient correction request.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLaboutreference

Search for PatientCorrectionTask or PatientCorrectionCommunication this PatientCorrectionCommunication is about.

 

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Documentation

Read a Task relating to a patient correction request.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLreasonReferencereference

For Disagreement Tasks, search for the original request for correction Communication.

 

Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • SHALL support read.

Documentation

Read a Patient Correction Bundle which contains a Patient Correction Communication and related resources.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "PatientCorrectionCapability",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pe"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/patient-corrections/ImplementationGuide/hl7.fhir.uv.patient-corrections"
          }
        ]
      }
    },
    {
      "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/uv/patient-corrections/ImplementationGuide/hl7.fhir.uv.patient-corrections"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/patient-corrections/CapabilityStatement/PatientCorrectionCapability",
  "version": "1.0.0",
  "name": "PatientCorrectionCapability",
  "title": "Patient Request for Corrections Capability Statement",
  "status": "active",
  "date": "2022-03-04",
  "publisher": "HL7 International / Patient Empowerment",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/patientempowerment"
        }
      ]
    },
    {
      "name": "Virginia Lorenzi",
      "telecom": [
        {
          "system": "email",
          "value": "vlorenzi@nyp.org"
        }
      ]
    },
    {
      "name": "David Pyke",
      "telecom": [
        {
          "system": "email",
          "value": "david@pyke.ca"
        }
      ]
    }
  ],
  "description": "Describes the capabilities for a FHIR server to support patient requests for corrections.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/uv/patient-corrections/ImplementationGuide/hl7.fhir.uv.patient-corrections"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Description of the needed resources to be supported by the FHIR server, and the different possible interactions.",
      "resource": [
        {
          "type": "Communication",
          "documentation": "Read a communication between a patient and a fulfiller relating to a patient correction request.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "about",
              "type": "reference",
              "documentation": "Search for PatientCorrectionTask or PatientCorrectionCommunication this PatientCorrectionCommunication is about."
            }
          ]
        },
        {
          "type": "Task",
          "documentation": "Read a Task relating to a patient correction request.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "reasonReference",
              "type": "reference",
              "documentation": "For Disagreement Tasks, search for the original request for correction Communication."
            }
          ]
        },
        {
          "type": "Bundle",
          "documentation": "Read a Patient Correction Bundle which contains a Patient Correction Communication and related resources.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        },
        {
          "code": "search-system"
        }
      ]
    }
  ]
}