US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
Draft as of 2025-03-31 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="CHAPI"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement CHAPI</b></p><a name="CHAPI"> </a><a name="hcCHAPI"> </a><a name="CHAPI-en-US"> </a><h2 id="title">Lighthouse Clinical Health API</h2><ul><li>Implementation Guide Version: 1.3.1 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2025-03-31 14:28:02+0000 </li><li>Published by: VA </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#AllergyIntolerance1-1">AllergyIntolerance</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-AllergyIntolerance.html">AllergyIntolerance</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Patient1-2">Patient</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-Patient.html">Patient</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Appointment1-3">Appointment</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-Appointment.html">Appointment</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Observation1-4">Observation</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-LabObservationChemhemtoxriaserObservation.html">Lab Observation: Chem, hem, tox, ria, ser Observation</a><br/> <a href="StructureDefinition-LabObservationMicrobiologyObservation.html">Lab Observation: Microbiology Observation</a><br/> <a href="StructureDefinition-LabObservationMicrobiologyBacteriologyObservation.html">Lab Observation: Microbiology Bacteriology Observation</a><br/> <a href="StructureDefinition-LabObservationMicrobiologyMycobacteriologyObservation.html">Lab Observation: Microbiology Mycobacteriology Observation</a><br/> <a href="StructureDefinition-LabObservationMicrobiologyMycologyObservation.html">Lab Observation: Microbiology Mycology Observation</a><br/> <a href="StructureDefinition-LabObservationMicrobiologyParasitologyObservation.html">Lab Observation: Microbiology Parasitology Observation</a><br/> <a href="StructureDefinition-LabObservationMicrobiologyVirologyObservation.html">Lab Observation: Microbiology Virology Observation</a><br/> <a href="StructureDefinition-LabObservation.html">Lab Observation</a><br/> <a href="StructureDefinition-SmokingStatusObservation.html">Smoking Status Observation</a><br/> <a href="StructureDefinition-VitalSigns.html">Vital Signs</a><br/> <a href="StructureDefinition-VitalSignsBP.html">Vital Signs: BP</a><br/> <a href="StructureDefinition-VitalSignsSpO2.html">Vital Signs: SpO2</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Specimen1-5">Specimen</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-LabObservationChemhemtoxriaserSpecimen.html">Lab Observation: Chem, hem, tox, ria, ser Specimen</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Encounter1-6">Encounter</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-EncounterOutpatient.html">Encounter: Outpatient</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Condition1-7">Condition</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-ConditionEncounterDiagnosis.html">Condition: Encounter Diagnosis</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Location1-8">Location</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-Location.html">Location</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#MedicationDispense1-9">MedicationDispense</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-MedicationDispenseOriginal.html">MedicationDispense: Original</a><br/> <a href="StructureDefinition-MedicationDispenseRefill.html">MedicationDispense: Refill</a><br/> <a href="StructureDefinition-MedicationDispensePartial.html">MedicationDispense: Partial</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#MedicationRequest1-10">MedicationRequest</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-MedicationRequestOutpatient.html">MedicationRequest: Outpatient</a><br/> <a href="StructureDefinition-MedicationRequestOutpatient.html">MedicationRequest: Outpatient</a><br/> <a href="StructureDefinition-MedicationRequestOutpatient.html">MedicationRequest: Outpatient</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Organization1-11">Organization</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-Organization.html">Organization</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Practitioner1-12">Practitioner</a></td><td>Supported Profiles<br/> <a href="StructureDefinition-Practitioner.html">Practitioner</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="AllergyIntolerance1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>AllergyIntolerance</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/allergyintolerance.html">AllergyIntolerance</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-AllergyIntolerance.html">AllergyIntolerance</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Patient</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/patient.html">Patient</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-Patient.html">Patient</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Appointment1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Appointment</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/appointment.html">Appointment</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-Appointment.html">Appointment</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Observation</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/observation.html">Observation</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-LabObservationChemhemtoxriaserObservation.html">Lab Observation: Chem, hem, tox, ria, ser Observation</a><br/><a href="StructureDefinition-LabObservationMicrobiologyObservation.html">Lab Observation: Microbiology Observation</a><br/><a href="StructureDefinition-LabObservationMicrobiologyBacteriologyObservation.html">Lab Observation: Microbiology Bacteriology Observation</a><br/><a href="StructureDefinition-LabObservationMicrobiologyMycobacteriologyObservation.html">Lab Observation: Microbiology Mycobacteriology Observation</a><br/><a href="StructureDefinition-LabObservationMicrobiologyMycologyObservation.html">Lab Observation: Microbiology Mycology Observation</a><br/><a href="StructureDefinition-LabObservationMicrobiologyParasitologyObservation.html">Lab Observation: Microbiology Parasitology Observation</a><br/><a href="StructureDefinition-LabObservationMicrobiologyVirologyObservation.html">Lab Observation: Microbiology Virology Observation</a><br/><a href="StructureDefinition-LabObservation.html">Lab Observation</a><br/><a href="StructureDefinition-SmokingStatusObservation.html">Smoking Status Observation</a><br/><a href="StructureDefinition-VitalSigns.html">Vital Signs</a><br/><a href="StructureDefinition-VitalSignsBP.html">Vital Signs: BP</a><br/><a href="StructureDefinition-VitalSignsSpO2.html">Vital Signs: SpO2</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Specimen1-5" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Specimen</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/specimen.html">Specimen</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-LabObservationChemhemtoxriaserSpecimen.html">Lab Observation: Chem, hem, tox, ria, ser Specimen</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Encounter1-6" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Encounter</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/encounter.html">Encounter</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-EncounterOutpatient.html">Encounter: Outpatient</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Condition1-7" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Condition</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/condition.html">Condition</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-ConditionEncounterDiagnosis.html">Condition: Encounter Diagnosis</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Location1-8" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Location</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/location.html">Location</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-Location.html">Location</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationDispense1-9" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>MedicationDispense</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/medicationdispense.html">MedicationDispense</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-MedicationDispenseOriginal.html">MedicationDispense: Original</a><br/><a href="StructureDefinition-MedicationDispenseRefill.html">MedicationDispense: Refill</a><br/><a href="StructureDefinition-MedicationDispensePartial.html">MedicationDispense: Partial</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationRequest1-10" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>MedicationRequest</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/medicationrequest.html">MedicationRequest</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-MedicationRequestOutpatient.html">MedicationRequest: Outpatient</a><br/><a href="StructureDefinition-MedicationRequestOutpatient.html">MedicationRequest: Outpatient</a><br/><a href="StructureDefinition-MedicationRequestOutpatient.html">MedicationRequest: Outpatient</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Organization1-11" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Organization</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/organization.html">Organization</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-Organization.html">Organization</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Practitioner1-12" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Practitioner</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-Practitioner.html">Practitioner</a></p></div></div><p/></div></div></div></div>
</text>
<url value="http://va.gov/fhir/CapabilityStatement/CHAPI"/>
<version value="1.3.1"/>
<title value="Lighthouse Clinical Health API"/>
<status value="draft"/>
<date value="2025-03-31T14:28:02.219Z"/>
<publisher value="VA"/>
<contact>
<name value="VA"/>
<telecom>
<system value="url"/>
<value value="https://www.va.gov"/>
</telecom>
</contact>
<description
value="This CapabilityStatement enumerates the profiles that the API should address, in the estimation of the enterprise mapping team. Some elements may not be appropriate for those cases; consult the actual API specification published by the API provider"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<rest>
<mode value="server"/>
<resource>
<type value="AllergyIntolerance"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/AllergyIntolerance"/>
</resource>
<resource>
<type value="Patient"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/Patient"/>
</resource>
<resource>
<type value="Appointment"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/Appointment"/>
</resource>
<resource>
<type value="Observation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationChemhemtoxriaserObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationMicrobiologyObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationMicrobiologyBacteriologyObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationMicrobiologyMycobacteriologyObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationMicrobiologyMycologyObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationMicrobiologyParasitologyObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationMicrobiologyVirologyObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/SmokingStatusObservation"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/VitalSigns"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/VitalSignsBP"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/VitalSignsSpO2"/>
</resource>
<resource>
<type value="Specimen"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/LabObservationChemhemtoxriaserSpecimen"/>
</resource>
<resource>
<type value="Encounter"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/EncounterOutpatient"/>
</resource>
<resource>
<type value="Condition"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/ConditionEncounterDiagnosis"/>
</resource>
<resource>
<type value="Location"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/Location"/>
</resource>
<resource>
<type value="MedicationDispense"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/MedicationDispenseOriginal"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/MedicationDispenseRefill"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/MedicationDispensePartial"/>
</resource>
<resource>
<type value="MedicationRequest"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/MedicationRequestOutpatient"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/MedicationRequestOutpatient"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/MedicationRequestOutpatient"/>
</resource>
<resource>
<type value="Organization"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/Organization"/>
</resource>
<resource>
<type value="Practitioner"/>
<supportedProfile
value="http://va.gov/fhir/StructureDefinition/Practitioner"/>
</resource>
</rest>
</CapabilityStatement>