Athena Core Implementation Guide
5.7.0 - release

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

: athenahealth Document details Subclass - JSON Representation

Active as of 2026-01-05

Raw json | Download

{
  "resourceType" : "SearchParameter",
  "id" : "ah-document-subclass",
  "meta" : {
    "source" : "athenacoreext"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: SearchParameter ah-document-subclass</b></p><a name=\"ah-document-subclass\"> </a><a name=\"hcah-document-subclass\"> </a><a name=\"ah-document-subclass-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><h2>AthenahealthDocumentSubClass</h2><p>Parameter <code>ah-document-subclass</code>:<code>token</code></p><div><p>Filter document events with resource type such as 'AdminDocument' , 'ClinicalDocument', 'Letter', 'MedicalRecord', 'PatientInfoOrder' etc. by document sub-class. Document sub-classes further classify the type of document e.g. 'LETTER' document type can be specified as 'LETTER_EPISODE', 'LETTER_PATIENTCARESUMMARY', 'LETTER_PATIENTCORRESPONDENCE', and 'LETTER_SUMMARYCARERECORD'. The list of sub-classes contains the following: 'ADMIN', 'ADMIN_ADMIN', 'ADMIN_BILLING', 'ADMIN_CONSENT', 'ADMIN_HIPAA', 'ADMIN_INSURANCEAPPROVAL', 'ADMIN_INSURANCECARD', 'ADMIN_INSURANCEDENIAL', 'ADMIN_LEGAL', 'ADMIN_MEDICALRECORDREQ', 'ADMIN_REFERRAL', 'ADMIN_SIGNEDFORMSLETTERS', 'ADMIN_VACCINATIONRECORD', 'BILLING', 'CLINICALDOCUMENT', 'CLINICALDOCUMENT_ADMISSIONDISCHARGE', 'CLINICALDOCUMENT_CASEREPORT', 'CLINICALDOCUMENT_CCDA', 'CLINICALDOCUMENT_CLINICALSUMMARY', 'CLINICALDOCUMENT_COMMUNICATORFORM', 'CLINICALDOCUMENT_CONSULTNOTE', 'CLINICALDOCUMENT_INPATIENTSUMMARY', 'CLINICALDOCUMENT_MENTALHEALTH', 'CLINICALDOCUMENT_OPERATIVENOTE', 'CLINICALDOCUMENT_URGENTCARE', 'CLINICALDOCUMENT_XDSSD', 'COVERSHEET', 'ELECTRONICREFERRAL_APPOINTMENTREQUEST', 'ENCOUNTERDOCUMENT_AUTHORIZATION', 'ENCOUNTERDOCUMENT_ENCOUNTERREVIEW', 'ENCOUNTERDOCUMENT_IMAGEDOC', 'ENCOUNTERDOCUMENT_PATIENTHISTORY', 'ENCOUNTERDOCUMENT_PROCEDUREDOC', 'ENCOUNTERDOCUMENT_PROGRESSNOTE', 'HIDDEN', 'HOSPITAL_ADMISSIONDISCHARGE', 'IMAGINGRESULT', 'LABRESULT', 'LETTER_EPISODE', 'LETTER_PATIENTCARESUMMARY', 'LETTER_PATIENTCORRESPONDENCE', 'LETTER_SUMMARYCARERECORD', 'MEDICALRECORD_CHARTTOABSTRACT', 'MEDICALRECORD_COUMADIN', 'MEDICALRECORD_GROWTHCHART', 'MEDICALRECORD_HISTORICAL', 'MEDICALRECORD_PATIENTDIARY', 'MEDICALRECORD_VACCINATION', 'PATIENTCASE_ADMINISTRATIVE', 'PATIENTCASE_BILLING', 'PATIENTCASE_CLINICALQUESTION', 'PATIENTCASE_ELECTRONICMEDICALRECORDS', 'PATIENTCASE_MEDICALRECORDS', 'PATIENTCASE_MEDICATION', 'PATIENTCASE_NEWRX', 'PATIENTCASE_OTHER', 'PATIENTCASE_PATIENTNOSHOW', 'PATIENTCASE_REFERRAL', 'PATIENTCASE_REFILL', 'PATIENTRECORD_AMBULATORYSUMMARY', 'PATIENTRECORD_CAREPLAN', 'PATIENTRECORD_CCD', 'PATIENTRECORD_DATAPORTABILITY', 'PHYSICIANAUTH', 'PHYSICIANAUTH_CAREPLANOVERSIGHT', 'PRESCRIPTION_CHANGE', 'PRESCRIPTION_CLARIFICATION', 'PRESCRIPTION_NEW', 'PRESCRIPTION_PRIORAUTHREQUEST', 'PRESCRIPTION_RENEWAL', 'SHAREABLE_COREORDER'</p>\n</div><table class=\"grid\"><tr><td>Resource</td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html\">AuditEvent</a></td></tr><tr><td>Expression</td><td><code>extension.where(url = 'https://fhir.athena.io/StructureDefinition/ah-document-details').extension.where(url = 'documentSubclass').value</code></td></tr><tr><td>Multiples</td><td><ul><li>multipleAnd: The parameter may only appear once</li><li>multipleOr: The parameter may have multiple values (separated by comma) where at least one must be true</li></ul></td></tr></table></div>"
  },
  "url" : "https://fhir.athena.io/SearchParameter/ah-document-subclass",
  "version" : "5.7.0",
  "name" : "AthenahealthDocumentSubClass",
  "status" : "active",
  "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" : "Filter document events with resource type such as 'AdminDocument' , 'ClinicalDocument', 'Letter', 'MedicalRecord', 'PatientInfoOrder' etc. by document sub-class. Document sub-classes further classify the type of document e.g. 'LETTER' document type can be specified as 'LETTER_EPISODE', 'LETTER_PATIENTCARESUMMARY', 'LETTER_PATIENTCORRESPONDENCE', and 'LETTER_SUMMARYCARERECORD'. The list of sub-classes contains the following: 'ADMIN', 'ADMIN_ADMIN', 'ADMIN_BILLING', 'ADMIN_CONSENT', 'ADMIN_HIPAA', 'ADMIN_INSURANCEAPPROVAL', 'ADMIN_INSURANCECARD', 'ADMIN_INSURANCEDENIAL', 'ADMIN_LEGAL', 'ADMIN_MEDICALRECORDREQ', 'ADMIN_REFERRAL', 'ADMIN_SIGNEDFORMSLETTERS', 'ADMIN_VACCINATIONRECORD', 'BILLING', 'CLINICALDOCUMENT', 'CLINICALDOCUMENT_ADMISSIONDISCHARGE', 'CLINICALDOCUMENT_CASEREPORT', 'CLINICALDOCUMENT_CCDA', 'CLINICALDOCUMENT_CLINICALSUMMARY', 'CLINICALDOCUMENT_COMMUNICATORFORM', 'CLINICALDOCUMENT_CONSULTNOTE', 'CLINICALDOCUMENT_INPATIENTSUMMARY', 'CLINICALDOCUMENT_MENTALHEALTH', 'CLINICALDOCUMENT_OPERATIVENOTE', 'CLINICALDOCUMENT_URGENTCARE', 'CLINICALDOCUMENT_XDSSD', 'COVERSHEET', 'ELECTRONICREFERRAL_APPOINTMENTREQUEST', 'ENCOUNTERDOCUMENT_AUTHORIZATION', 'ENCOUNTERDOCUMENT_ENCOUNTERREVIEW', 'ENCOUNTERDOCUMENT_IMAGEDOC', 'ENCOUNTERDOCUMENT_PATIENTHISTORY', 'ENCOUNTERDOCUMENT_PROCEDUREDOC', 'ENCOUNTERDOCUMENT_PROGRESSNOTE', 'HIDDEN', 'HOSPITAL_ADMISSIONDISCHARGE', 'IMAGINGRESULT', 'LABRESULT', 'LETTER_EPISODE', 'LETTER_PATIENTCARESUMMARY', 'LETTER_PATIENTCORRESPONDENCE', 'LETTER_SUMMARYCARERECORD', 'MEDICALRECORD_CHARTTOABSTRACT', 'MEDICALRECORD_COUMADIN', 'MEDICALRECORD_GROWTHCHART', 'MEDICALRECORD_HISTORICAL', 'MEDICALRECORD_PATIENTDIARY', 'MEDICALRECORD_VACCINATION', 'PATIENTCASE_ADMINISTRATIVE', 'PATIENTCASE_BILLING', 'PATIENTCASE_CLINICALQUESTION', 'PATIENTCASE_ELECTRONICMEDICALRECORDS', 'PATIENTCASE_MEDICALRECORDS', 'PATIENTCASE_MEDICATION', 'PATIENTCASE_NEWRX', 'PATIENTCASE_OTHER', 'PATIENTCASE_PATIENTNOSHOW', 'PATIENTCASE_REFERRAL', 'PATIENTCASE_REFILL', 'PATIENTRECORD_AMBULATORYSUMMARY', 'PATIENTRECORD_CAREPLAN', 'PATIENTRECORD_CCD', 'PATIENTRECORD_DATAPORTABILITY', 'PHYSICIANAUTH', 'PHYSICIANAUTH_CAREPLANOVERSIGHT', 'PRESCRIPTION_CHANGE', 'PRESCRIPTION_CLARIFICATION', 'PRESCRIPTION_NEW', 'PRESCRIPTION_PRIORAUTHREQUEST', 'PRESCRIPTION_RENEWAL', 'SHAREABLE_COREORDER'",
  "purpose" : "To filter document events  with resource type such as 'AdminDocument' , 'ClinicalDocument', 'Letter', 'MedicalRecord', 'PatientInfoOrder' etc. which have a specific document sub-class (e.g., 'ah-document-subclass=ADMIN_MEDICALRECORDREQ' or 'ah-document-subclass=ADMIN_MEDICALRECORDREQ,ADMIN_ADMIN')",
  "code" : "ah-document-subclass",
  "base" : [
    "AuditEvent"
  ],
  "type" : "token",
  "expression" : "extension.where(url = 'https://fhir.athena.io/StructureDefinition/ah-document-details').extension.where(url = 'documentSubclass').value",
  "multipleOr" : true,
  "multipleAnd" : false
}