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

• Narrative Content
• JSON

: athenahealth Appointment Enhanced Self Checkin - JSON Representation

Active as of 2026-01-05

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "ah-appointment-self-checkin-entry-url",
  "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-appointment-self-checkin-entry-url</b></p><a name=\"ah-appointment-self-checkin-entry-url\"> </a><a name=\"hcah-appointment-self-checkin-entry-url\"> </a><a name=\"ah-appointment-self-checkin-entry-url-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]/Appointment/[id]/$self-checkin-entry-url</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>patientId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The ID of the patient for whom the self check-in link is being generated.</p>\n</div></td></tr><tr><td>IN</td><td>brandId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The ID of the brand associated with the appointment.</p>\n</div></td></tr><tr><td>IN</td><td>departmentId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The ID of the department where the appointment is scheduled.</p>\n</div></td></tr><tr><td>IN</td><td>distributionMechanism</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The mechanism for distributing the self check-in link (e.g., email, SMS).</p>\n</div></td></tr><tr><td>IN</td><td>distributionRecipient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The recipient contact information (e.g., email address or phone number) for distributing the self check-in link.</p>\n</div></td></tr><tr><td>OUT</td><td>joinLink</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>The generated self check-in URL that the patient can use to complete the check-in process.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://fhir.athena.io/OperationDefinition/ah-appointment-self-checkin-entry-url",
  "version" : "5.7.0",
  "name" : "AthenahealthAppointmentSelfCheckinEntryUrl",
  "title" : "athenahealth Appointment Enhanced Self Checkin",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-01-05T06:17:09+00:00",
  "publisher" : "athenahealth",
  "contact" : [
    {
      "name" : "FHIR Enablement Team",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:fhir-enablement@athenahealth.com"
        }
      ]
    }
  ],
  "description" : "Generate a patient self check in link. Link can be used for up to 1 week or 10 usages. Patient will need enter demographic info after following link.",
  "code" : "self-checkin-entry-url",
  "resource" : [
    "Appointment"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "patientId",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The ID of the patient for whom the self check-in link is being generated.",
      "type" : "string"
    },
    {
      "name" : "brandId",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The ID of the brand associated with the appointment.",
      "type" : "string"
    },
    {
      "name" : "departmentId",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The ID of the department where the appointment is scheduled.",
      "type" : "string"
    },
    {
      "name" : "distributionMechanism",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The mechanism for distributing the self check-in link (e.g., email, SMS).",
      "type" : "string"
    },
    {
      "name" : "distributionRecipient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The recipient contact information (e.g., email address or phone number) for distributing the self check-in link.",
      "type" : "string"
    },
    {
      "name" : "joinLink",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The generated self check-in URL that the patient can use to complete the check-in process.",
      "type" : "uri"
    }
  ]
}