Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• JSON

: athenahealth Sync External Patient - JSON Representation

Active as of 2025-04-17

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "ah-sync-external-patient",
  "meta" : {
    "source" : "athenacoreext"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ah-sync-external-patient</b></p><a name=\"ah-sync-external-patient\"> </a><a name=\"hcah-sync-external-patient\"> </a><a name=\"ah-sync-external-patient-en-US\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Information Source: <a href=\"https://simplifier.net/resolve?scope=ig-athena-core@dev&amp;canonical=https://fhir.athena.io/core/athenacoreext\">athenacoreext</a></p></div><p>URL: [base]/Patient/$sync-external</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>patient</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>Use this to provide an entire set of patient details from the user to save it in Athena Directory (e.g. POST a patient record to Patient/$sync-external).</p>\n</div></td></tr><tr><td>IN</td><td>priorityFlag</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>If this parameter is set as (priorityFlag: true) then the patient resources would be added to the priority queue and these resources would ingested faster. If this parameter is set as (priorityFlag: false) or not specified in the input then the patient resources would be added to the non-priority queue and these resources would be ingested based on the current lag in the non-priority queue.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://fhir.athena.io/OperationDefinition/ah-sync-external-patient",
  "version" : "4.2.0",
  "name" : "AthenahealthSyncExternalPatient",
  "title" : "athenahealth Sync External Patient",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-04-17T16:42:09+00:00",
  "publisher" : "athenahealth",
  "contact" : [
    {
      "name" : "FHIR Enablement Team",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:fhir-enablement@athenahealth.com"
        }
      ]
    }
  ],
  "description" : "The $sync-external operation is used to replicate Patient resources from an external source system into athenahealth's Patient Directory. This allows these records to be linked to athenahealth's master Person index where applicable and queried using the Patient/$match operation (subject to pre-established access control restrictions). Note that this operation is asynchronous. A 202 status response indicates that the input Patient resource(s) have passed initial validation and been queued for ingestion, but it may take some minutes before the records are available to search.",
  "code" : "sync-external",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "Use this to provide an entire set of patient details from the user to save it in Athena Directory (e.g. POST a patient record to Patient/$sync-external).",
      "type" : "Patient"
    },
    {
      "name" : "priorityFlag",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If this parameter is set as (priorityFlag: true) then the patient resources would be added to the priority queue and these resources would ingested faster. If this parameter is set as (priorityFlag: false) or not specified in the input then the patient resources would be added to the non-priority queue and these resources would be ingested based on the current lag in the non-priority queue.",
      "type" : "boolean"
    }
  ]
}