haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build United States of America flag

haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Reconcile medications - JSON Representation

Active as of 2026-09-25

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "reconcile-medications",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition reconcile-medications</b></p><a name=\"reconcile-medications\"> </a><a name=\"hcreconcile-medications\"> </a><p>URL: [base]/$reconcile-medications</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>bundle</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The patient's medication records, as a Bundle of type collection or searchset. This is also the bare-body form: POST the Bundle itself as the request body, with nothing on the URL, and the list is evaluated as of the time of the request.</p>\n</div></td></tr><tr><td>IN</td><td>resource</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>One resource per repetition, for the Parameters form: a MedicationRequest, MedicationStatement, MedicationDispense or MedicationAdministration, or a Medication that one of those records references. Every part carries an id. A record's Medication/{id} reference resolves to the Medication part with that id, or to a Medication contained in the record, and the response names each source record as {resourceType}/{id}.</p>\n</div></td></tr><tr><td>IN</td><td>asOf</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>The date and time to evaluate the list as of. Parameters form only: the bare-body form evaluates the list as of the time of the request.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The reconciled list: a Bundle conforming to haau3 Reconciled Medication Bundle, returned as the response body itself.</p>\n</div></td></tr></table><div><p>Send <code>bundle</code>, or one or more <code>resource</code> parts, but not both. Every record must name the same patient in <code>subject</code>. A request is refused, with an OperationOutcome that names the reason, for a resource of any other type, records that name two patients or none, a Bundle that is not a <code>collection</code> or <code>searchset</code>, a body over 16 MiB, a resource part with no id, or malformed content. A record that names no medication, or whose <code>medicationReference</code> cannot be resolved, is skipped with a warning that names only its <code>fullUrl</code>. The response is the Bundle itself, conforming to <a href=\"StructureDefinition-haau3-reconciled-medication-bundle.html\">haau3 Reconciled Medication Bundle</a>, not a Parameters resource.</p>\n</div></div>"
  },
  "url" : "https://haau3.com/fhir/OperationDefinition/reconcile-medications",
  "version" : "1.0.0",
  "name" : "ReconcileMedications",
  "title" : "Reconcile medications",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-09-25",
  "publisher" : "haau3",
  "contact" : [
    {
      "name" : "haau3",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://haau3.com"
        },
        {
          "system" : "email",
          "value" : "hello@haau3.com"
        }
      ]
    }
  ],
  "description" : "Reconciles one patient's medication records, which may come from many sources and overlap, into one clean medication list. The list holds one entry per clinical drug, each a [haau3 Reconciled MedicationRequest](StructureDefinition-haau3-reconciled-medication-request.html) with a [haau3 Reconciled Medication Provenance](StructureDefinition-haau3-reconciled-medication-provenance.html) naming the records it came from. Software computes the list; no person curates it.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "reconcile-medications",
  "comment" : "Send `bundle`, or one or more `resource` parts, but not both. Every record must name the same patient in `subject`. A request is refused, with an OperationOutcome that names the reason, for a resource of any other type, records that name two patients or none, a Bundle that is not a `collection` or `searchset`, a body over 16 MiB, a resource part with no id, or malformed content. A record that names no medication, or whose `medicationReference` cannot be resolved, is skipped with a warning that names only its `fullUrl`. The response is the Bundle itself, conforming to [haau3 Reconciled Medication Bundle](StructureDefinition-haau3-reconciled-medication-bundle.html), not a Parameters resource.",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "bundle",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The patient's medication records, as a Bundle of type collection or searchset. This is also the bare-body form: POST the Bundle itself as the request body, with nothing on the URL, and the list is evaluated as of the time of the request.",
      "type" : "Bundle"
    },
    {
      "name" : "resource",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "One resource per repetition, for the Parameters form: a MedicationRequest, MedicationStatement, MedicationDispense or MedicationAdministration, or a Medication that one of those records references. Every part carries an id. A record's Medication/{id} reference resolves to the Medication part with that id, or to a Medication contained in the record, and the response names each source record as {resourceType}/{id}.",
      "type" : "Resource"
    },
    {
      "name" : "asOf",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The date and time to evaluate the list as of. Parameters form only: the bare-body form evaluates the list as of the time of the request.",
      "type" : "dateTime"
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile",
          "valueUri" : "https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-bundle"
        }
      ],
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The reconciled list: a Bundle conforming to haau3 Reconciled Medication Bundle, returned as the response body itself.",
      "type" : "Bundle"
    }
  ]
}