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

• Narrative Content
• JSON

: athenahealth Slot Template Appointment Search - JSON Representation

Active as of 2026-08-20

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "ah-slot-template-appointment",
  "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-slot-template-appointment</b></p><a name=\"ah-slot-template-appointment\"> </a><a name=\"hcah-slot-template-appointment\"> </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]/Slot?_query=templateAppointment&amp;...</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>ah-practice</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>athenahealth Practice Organization. The parameter value should be a FHIR Organization reference, such as Organization/a-1.Practice-14417.</p>\n</div></td></tr><tr><td>IN</td><td>ah-template-appointment</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Template Appointment reference used to search for matching Slot resources.</p>\n</div></td></tr><tr><td>IN</td><td>service-type</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td><a href=\"ValueSet-ah-appointment-service-type.html\">athenahealth Appointment Service Type</a> (Required)</td><td><div><p>Appointment service type exact token filter. Use the standard token :in modifier, service-type:in, with https://fhir.athena.io/ValueSet/ah-generic-appointment-service-type to search by generic ValueSet membership.</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td><a href=\"ValueSet-ah-slot-template-appointment-status.html\">athenahealth Slot Template Appointment Status</a> (Required)</td><td><div><p>Slot status filter. Supported values are free and busy.</p>\n</div></td></tr><tr><td>OUT</td><td>result</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Search results.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://fhir.athena.io/OperationDefinition/ah-slot-template-appointment",
  "version" : "5.13.0",
  "name" : "AthenahealthSlotTemplateAppointment",
  "title" : "athenahealth Slot Template Appointment Search",
  "status" : "active",
  "kind" : "query",
  "date" : "2026-08-20T23:36:36+00:00",
  "publisher" : "athenahealth",
  "contact" : [
    {
      "name" : "FHIR Enablement Team",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:fhir-enablement@athenahealth.com"
        }
      ]
    }
  ],
  "description" : "The named query _query=templateAppointment supports searching for Slot resources related to a template appointment.",
  "code" : "templateAppointment",
  "resource" : [
    "Slot"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "ah-practice",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "athenahealth Practice Organization. The parameter value should be a FHIR Organization reference, such as Organization/a-1.Practice-14417.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "ah-template-appointment",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Template Appointment reference used to search for matching Slot resources.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "service-type",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Appointment service type exact token filter. Use the standard token :in modifier, service-type:in, with https://fhir.athena.io/ValueSet/ah-generic-appointment-service-type to search by generic ValueSet membership.",
      "type" : "string",
      "searchType" : "token",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://fhir.athena.io/ValueSet/ah-appointment-service-type"
      }
    },
    {
      "name" : "status",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Slot status filter. Supported values are free and busy.",
      "type" : "string",
      "searchType" : "token",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://fhir.athena.io/ValueSet/ah-slot-template-appointment-status"
      }
    },
    {
      "name" : "result",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Search results.",
      "type" : "Bundle"
    }
  ]
}