US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
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 |
{
"resourceType" : "CapabilityStatement",
"id" : "AMPL",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement AMPL</b></p><a name=\"AMPL\"> </a><a name=\"hcAMPL\"> </a><a name=\"AMPL-en-US\"> </a><h2 id=\"title\">AMPL GUI</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=\"#Patient1-1\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<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=\"#Immunization1-2\">Immunization</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-ImmunizationImmunization.html\">Immunization Immunization</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-3\">Encounter</a></td><td>Supported Profiles<br/>\u00a0\u00a0<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=\"#Observation1-4\">Observation</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-ImmunizationObservation.html\">Immunization Observation</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-5\">Location</a></td><td>Supported Profiles<br/>\u00a0\u00a0<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=\"#MedicationRequest1-6\">MedicationRequest</a></td><td>Supported Profiles<br/>\u00a0\u00a0<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=\"#MedicationDispense1-7\">MedicationDispense</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-MedicationDispenseOriginal.html\">MedicationDispense: Original</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-MedicationDispenseRefill.html\">MedicationDispense: Refill</a><br/>\u00a0\u00a0<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=\"#Practitioner1-8\">Practitioner</a></td><td>Supported Profiles<br/>\u00a0\u00a0<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><tr><td><a href=\"#Task1-9\">Task</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-MedRefillRequestMHVTask.html\">MedRefillRequestMHV Task</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-10\">Organization</a></td><td>Supported Profiles<br/>\u00a0\u00a0<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=\"#Provenance1-11\">Provenance</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-MedRefillRequestMHVProvenancereview.html\">MedRefillRequestMHV Provenance[review]</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-MedRefillRequestMHVProvenancecreate.html\">MedRefillRequestMHV Provenance[create]</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=\"Patient1-1\" 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=\"Immunization1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Immunization</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/immunization.html\">Immunization</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-ImmunizationImmunization.html\">Immunization Immunization</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Encounter1-3\" 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=\"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-ImmunizationObservation.html\">Immunization Observation</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Location1-5\" 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=\"MedicationRequest1-6\" 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></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationDispense1-7\" 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=\"Practitioner1-8\" 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 class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Task1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Task</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/task.html\">Task</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-MedRefillRequestMHVTask.html\">MedRefillRequestMHV Task</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-10\" 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=\"Provenance1-11\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Provenance</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/provenance.html\">Provenance</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-MedRefillRequestMHVProvenancereview.html\">MedRefillRequestMHV Provenance[review]</a><br/><a href=\"StructureDefinition-MedRefillRequestMHVProvenancecreate.html\">MedRefillRequestMHV Provenance[create]</a></p></div></div><p/></div></div></div></div>"
},
"url" : "http://va.gov/fhir/CapabilityStatement/AMPL",
"version" : "1.3.1",
"title" : "AMPL GUI",
"status" : "draft",
"date" : "2025-03-31T14:28:02.224Z",
"publisher" : "VA",
"contact" : [
{
"name" : "VA",
"telecom" : [
{
"system" : "url",
"value" : "https://www.va.gov"
}
]
}
],
"description" : "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" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Patient",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/Patient"
]
},
{
"type" : "Immunization",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/ImmunizationImmunization"
]
},
{
"type" : "Encounter",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/EncounterOutpatient"
]
},
{
"type" : "Observation",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/ImmunizationObservation"
]
},
{
"type" : "Location",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/Location"
]
},
{
"type" : "MedicationRequest",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/MedicationRequestOutpatient"
]
},
{
"type" : "MedicationDispense",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/MedicationDispenseOriginal"🔗 ,
"http://va.gov/fhir/StructureDefinition/MedicationDispenseRefill"🔗 ,
"http://va.gov/fhir/StructureDefinition/MedicationDispensePartial"
]
},
{
"type" : "Practitioner",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/Practitioner"
]
},
{
"type" : "Task",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/MedRefillRequestMHVTask"
]
},
{
"type" : "Organization",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/Organization"
]
},
{
"type" : "Provenance",
"supportedProfile" : [
🔗 "http://va.gov/fhir/StructureDefinition/MedRefillRequestMHVProvenancereview"🔗 ,
"http://va.gov/fhir/StructureDefinition/MedRefillRequestMHVProvenancecreate"
]
}
]
}
]
}