PACIO Personal Functioning and Engagement Implementation Guide
1.0.0-ballot - ballot1 US

This page is part of the PACIO Personal Functioning and Engagement Implementation Guide (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: Personal Functioning and Engagement Capability Statement - XML Representation

Draft as of 2022-08-12

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="pacio-pfe-cap"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Personal_Functioning_And_Engagement_CapabilityStatement</h2><div><p>This Capability Statement defines the expected capabilities of a Personal Functioning and Engagement FHIR server conforming to the Personal Functioning and Engagement Implementation Guide.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET past versions of resources (vread interaction)">V-Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="PATCH a new resource version (patch interaction)">Patch</b></th><th><b title="POST a new resource (create interaction)">Create</b></th><th><b title="DELETE a resource (delete interaction)">Delete</b></th><th><b title="GET changes to a resource (history interaction on instance)">Updates</b></th><th><b title="GET changes for all resources of the type (history interaction on type)">History</b></th></tr><tr><td>Observation</td><td>Supported profiles:<br/>  <a href="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-collection">http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-collection</a><br/>  <a href="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation">http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DiagnosticReport</td><td><a href="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-narrative-history-of-status">http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-narrative-history-of-status</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>DeviceUseStatement</td><td><a href="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-use-of-device">http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-use-of-device</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/pacio-pfe/CapabilityStatement/pacio-pfe-cap"/>
  <version value="1.0.0-ballot"/>
  <name value="Personal_Functioning_And_Engagement_CapabilityStatement"/>
  <title value="Personal Functioning and Engagement Capability Statement"/>
  <status value="draft"/>
  <date value="2022-08-12T00:00:00+00:00"/>
  <publisher value="HL7 Patient Care Work Group"/>
  <contact>
    <name value="HL7 Patient Care Work Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/patientcare"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="patientcare@lists.HL7.org"/>
    </telecom>
  </contact>
  <contact>
    <name value="PACIO project"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/patientcare"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="info@pacioproject.org"/>
    </telecom>
  </contact>
  <description
               value="This Capability Statement defines the expected capabilities of a Personal Functioning and Engagement FHIR server conforming to the Personal Functioning and Engagement Implementation Guide."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="xml"/>
  <format value="json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/pacio-pfe/ImplementationGuide/hl7.fhir.us.pacio-pfe"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Observation"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-collection"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="vread"/>
      </interaction>
      <interaction>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <code value="history-type"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="patch"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <conditionalDelete value="multiple"/>
      <referencePolicy value="literal"/>
      <referencePolicy value="logical"/>
      <searchInclude value="Observation.subject"/>
      <searchInclude value="Observation.based-on"/>
      <searchInclude value="Observation.patient"/>
      <searchInclude value="Observation.specimen"/>
      <searchInclude value="Observation.context"/>
      <searchInclude value="Observation.performer"/>
      <searchInclude value="Observation.encounter"/>
      <searchInclude value="Observation.device"/>
      <searchRevInclude value="ChargeItem.service"/>
      <searchRevInclude value="ClinicalImpression.finding-ref"/>
      <searchRevInclude value="ClinicalImpression.investigation"/>
      <searchRevInclude value="DiagnosticReport.result"/>
      <searchRevInclude value="Immunization.reaction"/>
      <searchRevInclude value="ImmunizationRecommendation.information"/>
      <searchRevInclude value="MedicationStatement.part-of"/>
      <searchRevInclude value="Procedure.part-of"/>
      <searchRevInclude value="QuestionnaireResponse.parent"/>
      <searchParam>
        <name value="date"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
        <type value="date"/>
        <documentation
                       value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/>
      </searchParam>
      <searchParam>
        <name value="combo-data-absent-reason"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-combo-data-absent-reason"/>
        <type value="token"/>
        <documentation
                       value="The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing."/>
      </searchParam>
      <searchParam>
        <name value="code"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
        <type value="token"/>
        <documentation value="The code of the observation type"/>
      </searchParam>
      <searchParam>
        <name value="combo-code-value-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity"/>
        <type value="composite"/>
        <documentation
                       value="Code and quantity value parameter pair, including in components"/>
      </searchParam>
      <searchParam>
        <name value="subject"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-subject"/>
        <type value="reference"/>
        <documentation value="The subject that the observation is about"/>
      </searchParam>
      <searchParam>
        <name value="component-data-absent-reason"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-component-data-absent-reason"/>
        <type value="token"/>
        <documentation
                       value="The reason why the expected value in the element Observation.component.value[x] is missing."/>
      </searchParam>
      <searchParam>
        <name value="value-concept"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-value-concept"/>
        <type value="token"/>
        <documentation
                       value="The value of the observation, if the value is a CodeableConcept"/>
      </searchParam>
      <searchParam>
        <name value="value-date"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-value-date"/>
        <type value="date"/>
        <documentation
                       value="The value of the observation, if the value is a date or period of time"/>
      </searchParam>
      <searchParam>
        <name value="code-value-string"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-code-value-string"/>
        <type value="composite"/>
        <documentation value="Code and string value parameter pair"/>
      </searchParam>
      <searchParam>
        <name value="component-code-value-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity"/>
        <type value="composite"/>
        <documentation
                       value="Component code and component quantity value parameter pair"/>
      </searchParam>
      <searchParam>
        <name value="based-on"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-based-on"/>
        <type value="reference"/>
        <documentation value="Reference to the test or procedure request."/>
      </searchParam>
      <searchParam>
        <name value="code-value-date"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-code-value-date"/>
        <type value="composite"/>
        <documentation value="Code and date/time value parameter pair"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
        <type value="reference"/>
        <documentation
                       value="The subject that the observation is about (if patient)"/>
      </searchParam>
      <searchParam>
        <name value="specimen"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-specimen"/>
        <type value="reference"/>
        <documentation value="Specimen used for this observation"/>
      </searchParam>
      <searchParam>
        <name value="component-code"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-component-code"/>
        <type value="token"/>
        <documentation value="The component code of the observation type"/>
      </searchParam>
      <searchParam>
        <name value="code-value-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity"/>
        <type value="composite"/>
        <documentation value="Code and quantity value parameter pair"/>
      </searchParam>
      <searchParam>
        <name value="combo-code-value-concept"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept"/>
        <type value="composite"/>
        <documentation
                       value="Code and coded value parameter pair, including in components"/>
      </searchParam>
      <searchParam>
        <name value="value-string"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-value-string"/>
        <type value="string"/>
        <documentation
                       value="The value of the observation, if the value is a string, and also searches in CodeableConcept.text"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
        <type value="token"/>
        <documentation value="The unique id for a particular observation"/>
      </searchParam>
      <searchParam>
        <name value="performer"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-performer"/>
        <type value="reference"/>
        <documentation value="Who performed the observation"/>
      </searchParam>
      <searchParam>
        <name value="combo-code"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-combo-code"/>
        <type value="token"/>
        <documentation
                       value="The code of the observation type or component type"/>
      </searchParam>
      <searchParam>
        <name value="method"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-method"/>
        <type value="token"/>
        <documentation value="The method used for the observation"/>
      </searchParam>
      <searchParam>
        <name value="value-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-value-quantity"/>
        <type value="quantity"/>
        <documentation
                       value="The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"/>
      </searchParam>
      <searchParam>
        <name value="component-value-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-component-value-quantity"/>
        <type value="quantity"/>
        <documentation
                       value="The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"/>
      </searchParam>
      <searchParam>
        <name value="data-absent-reason"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason"/>
        <type value="token"/>
        <documentation
                       value="The reason why the expected value in the element Observation.value[x] is missing."/>
      </searchParam>
      <searchParam>
        <name value="combo-value-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-combo-value-quantity"/>
        <type value="quantity"/>
        <documentation
                       value="The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"/>
      </searchParam>
      <searchParam>
        <name value="encounter"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-encounter"/>
        <type value="reference"/>
        <documentation value="Encounter related to the observation"/>
      </searchParam>
      <searchParam>
        <name value="code-value-concept"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-code-value-concept"/>
        <type value="composite"/>
        <documentation value="Code and coded value parameter pair"/>
      </searchParam>
      <searchParam>
        <name value="component-code-value-concept"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept"/>
        <type value="composite"/>
        <documentation
                       value="Component code and component coded value parameter pair"/>
      </searchParam>
      <searchParam>
        <name value="component-value-concept"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-component-value-concept"/>
        <type value="token"/>
        <documentation
                       value="The value of the component observation, if the value is a CodeableConcept"/>
      </searchParam>
      <searchParam>
        <name value="category"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-category"/>
        <type value="token"/>
        <documentation value="The classification of the type of observation"/>
      </searchParam>
      <searchParam>
        <name value="device"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-device"/>
        <type value="reference"/>
        <documentation value="The Device that generated the observation data."/>
      </searchParam>
      <searchParam>
        <name value="combo-value-concept"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept"/>
        <type value="token"/>
        <documentation
                       value="The value or component value of the observation, if the value is a CodeableConcept"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Observation-status"/>
        <type value="token"/>
        <documentation value="The status of the observation"/>
      </searchParam>
    </resource>
    <resource>
      <type value="DiagnosticReport"/>
      <profile
               value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-narrative-history-of-status"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="vread"/>
      </interaction>
      <interaction>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <code value="history-type"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="patch"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <conditionalDelete value="multiple"/>
      <referencePolicy value="literal"/>
      <referencePolicy value="logical"/>
      <searchInclude value="DiagnosticReport.based-on"/>
      <searchInclude value="DiagnosticReport.subject"/>
      <searchInclude value="DiagnosticReport.patient"/>
      <searchInclude value="DiagnosticReport.encounter"/>
      <searchInclude value="DiagnosticReport.media"/>
      <searchInclude value="DiagnosticReport.performer"/>
      <searchInclude value="DiagnosticReport.result"/>
      <searchInclude value="DiagnosticReport.results-interpreter"/>
      <searchInclude value="DiagnosticReport.specimen"/>
      <searchParam>
        <name value="date"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-date"/>
        <type value="date"/>
        <documentation
                       value="Obtained date/time. If the obtained element is a period, a date that falls in the period"/>
      </searchParam>
      <searchParam>
        <name value="code"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-code"/>
        <type value="token"/>
        <documentation value="The code of the report type"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
        <type value="reference"/>
        <documentation value="The subject that the report is about (if patient)"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
        <type value="token"/>
        <documentation value="The unique id for a particular report"/>
      </searchParam>
      <searchParam>
        <name value="encounter"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/clinical-encounter"/>
        <type value="reference"/>
        <documentation value="Encounter related to the report"/>
      </searchParam>
    </resource>
    <resource>
      <type value="DeviceUseStatement"/>
      <profile
               value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-use-of-device"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="vread"/>
      </interaction>
      <interaction>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <code value="history-type"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="patch"/>
      </interaction>
      <conditionalCreate value="true"/>
      <conditionalUpdate value="true"/>
      <conditionalDelete value="multiple"/>
      <referencePolicy value="literal"/>
      <referencePolicy value="logical"/>
      <searchInclude value="DeviceUseStatement.subject"/>
      <searchInclude value="DeviceUseStatement.patient"/>
      <searchInclude value="DeviceUseStatement.device"/>
      <searchParam>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DeviceUseStatement-identifier"/>
        <type value="token"/>
        <documentation value="Search by identifier"/>
      </searchParam>
      <searchParam>
        <name value="subject"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DeviceUseStatement-subject"/>
        <type value="reference"/>
        <documentation value="Search by subject"/>
      </searchParam>
      <searchParam>
        <name value="patient"/>
        <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
        <type value="reference"/>
        <documentation value="Search by subject - a patient"/>
      </searchParam>
      <searchParam>
        <name value="device"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/DeviceUseStatement-device"/>
        <type value="reference"/>
        <documentation value="Search by device"/>
      </searchParam>
    </resource>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="batch"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="search-system"/>
    </interaction>
    <searchParam>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <name value="_content"/>
      <definition value="http://hl7.org/fhir/SearchParameter/Resource-content"/>
      <type value="string"/>
    </searchParam>
    <searchParam>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="_id"/>
      <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
      <type value="token"/>
    </searchParam>
    <searchParam>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="_lastUpdated"/>
      <definition
                  value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
      <type value="date"/>
    </searchParam>
    <searchParam>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <name value="_security"/>
      <definition value="http://hl7.org/fhir/SearchParameter/Resource-security"/>
      <type value="token"/>
    </searchParam>
    <searchParam>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <name value="_text"/>
      <definition
                  value="http://hl7.org/fhir/SearchParameter/DomainResource-text"/>
      <type value="string"/>
    </searchParam>
    <searchParam>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <name value="_query"/>
      <definition value="http://hl7.org/fhir/SearchParameter/Resource-query"/>
      <type value="token"/>
    </searchParam>
  </rest>
</CapabilityStatement>