Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Table of Contents

.. 0 Table of Contents
... 1 Home
... 2 Background
... 3 Useful Downloads
... 4 IG Change History
... 5 Electronic Health Information (EHI) Export
... 6 Operations
... 7 RESTful API
... 8 Security
... 9 Delete by encounter id
... 10 Delete by context
... 11 Delete by photo
... 12 OperationDefinition
... 13 Operation: conceptmap-translate
... 14 Operation: serviceRequest-generate
... 15 Operation: documentReference-generate
... 16 Operation: documentReference-generateCDA
... 17 Operation: documentReference-docref
... 18 Operation: device-everything
... 19 Operation: Encounter-everything
... 20 Operation: Patient-everything
... 21 Operation: practitioner-everything
... 22 Operation: Patient-generate
... 23 Operation: relatedperson-everything
... 24 Operation: group-export
... 25 Operation: valueset-expand
... 26 Operation: valueset-lookup
... 27 Operation: valueset-validatecode
... 28 athena-billingstatement-profile-dataextformat
... 29 Artifacts Summary
.... 29.1 athenaPractice CapabilityStatement
.... 29.2 athenaFlow CapabilityStatement
.... 29.3 Operation - unique
.... 29.4 Profile - Athena Custom Adjustment
.... 29.5 Profile - Athena Custom BillingStatement
.... 29.6 Profile - Athena Custom Charge
.... 29.7 Profile - Athena Custom Claim
.... 29.8 Profile - Athena Custom Collection
.... 29.9 Profile - Athena Custom Deductible
.... 29.10 Profile - Athena Custom Eligibility
.... 29.11 Profile - Athena Custom PatientInsurance
.... 29.12 Profile - Athena Custom Payment
.... 29.13 Profile - Athena Custom OperationOutcome
.... 29.14 Profile - Athena Condition
.... 29.15 Profile - Athena Patient
.... 29.16 Profile - Athena Organization
.... 29.17 Profile - Athena Practitioner
.... 29.18 Profile - Athena PractitionerRole
.... 29.19 Profile - Athena Encounter
.... 29.20 Profile - Athena MedRequest
.... 29.21 Profile - Athena AllergyIntolerance
.... 29.22 Profile - Athena Location
.... 29.23 Profile - Athena Device
.... 29.24 Profile - Athena FamilyMemberHistory
.... 29.25 Profile - Athena Goal
.... 29.26 Profile - Athena DocumentReference
.... 29.27 Profile - Athena ServiceRequest
.... 29.28 Profile - Athena Specimen
.... 29.29 Profile - Athena MedicationStatement
.... 29.30 Profile - Athena MedicationAdministration
.... 29.31 Profile - Athena MedicationDispense
.... 29.32 Profile - Athena CarePlan
.... 29.33 Profile - Athena Binary
.... 29.34 Profile - Athena Slot
.... 29.35 Profile - Athena Appointment
.... 29.36 Profile - Athena Coverage
.... 29.37 Profile - Athena Schedule
.... 29.38 Profile - Athena Medication
.... 29.39 Profile - Athena Posting
.... 29.40 Profile - Athena Observation
.... 29.41 Profile - Athena Immunization
.... 29.42 Profile - Athena AuditEvent
.... 29.43 Profile - Athena ClinicalImpression
.... 29.44 Profile - Athena CareTeam
.... 29.45 Profile - Athena RelatedPerson
.... 29.46 Profile - Athena Consent
.... 29.47 Profile - Athena Procedure
.... 29.48 Profile - Athena DiagnosticReport
.... 29.49 Profile - Athena Provenance
.... 29.50 Profile - Athena Subscription
.... 29.51 Profile - Athena Account
.... 29.52 Profile - Athena Endpoint
.... 29.53 Profile - Athena Media
.... 29.54 AthenaConceptMap
.... 29.55 AthenaList
.... 29.56 AthenaNamingSystem
.... 29.57 AthenaValueSet
.... 29.58 Extension - RESPPROVID
.... 29.59 Extension - REFDOCID
.... 29.60 Extension - educationProvided
.... 29.61 extension - BIRTHTIME
.... 29.62 Extension - preferredContact
.... 29.63 Extension - patientAsGuarantor
.... 29.64 Extension - genderIdentity
.... 29.65 Extension - sexualOrientation
.... 29.66 Extension - guarantorDetails
.... 29.67 Extension - SUMMARY
.... 29.68 Extension - DESCRIPTION
.... 29.69 Extension - AUTHENTICATOR
.... 29.70 MedicationRequest Extension - ddid
.... 29.71 MedicationRequest Extension - rxnorm
.... 29.72 MedicationRequest Extension - dispenser
.... 29.73 MedicationRequest Extension - dispenseInstructions
.... 29.74 MedicationRequest Extension - ndc
.... 29.75 medicationrequest Extension - datewritten
.... 29.76 MedicationAdministration Extension - rxnorm
.... 29.77 MedicationAdministration Extension - ndc
.... 29.78 MedicationAdministration Extension - ddid
.... 29.79 Extension - encounter
.... 29.80 Extension - enddate
.... 29.81 DocumentReference Extension - refprovid
.... 29.82 MedicationStatement Extension - ddid
.... 29.83 DocumentReference Extension - pubtime
.... 29.84 MedicationStatement Extension - rxnorm
.... 29.85 MedicationStatement Extension - ndc
.... 29.86 MedicationStatement Extension - medcategory
.... 29.87 Coverage Extension - coverage-type
.... 29.88 Coverage Extension - subscriber-name
.... 29.89 Slot Extension - facility
.... 29.90 Immunization Extension - VFCEligibility
.... 29.91 Posting Extension - Batch
.... 29.92 Immunization Extension - NotGiven
.... 29.93 Posting Extension - PayerName
.... 29.94 Posting Extension - patientVisitId
.... 29.95 Consent Extension - encounter
.... 29.96 Consent Extension - period
.... 29.97 Subscription Extension - owner
.... 29.98 Subscription Extension - source id
.... 29.99 Subscription Extension - source name
.... 29.100 Account Extension - patient Visit Id
.... 29.101 Account Extension - Doctor Id
.... 29.102 Account Extension - company Id
.... 29.103 Account Extension - Visit Date
.... 29.104 Account Extension - facility Id
.... 29.105 Account Extension - Bill Status
.... 29.106 Account Extension - Current Carrier
.... 29.107 Account Extension - financial Class Mid
.... 29.108 Pronouns Extension
.... 29.109 US Core Sex for Clinical Use Extension (Custom IG)
.... 29.110 US Core Tribal Affiliation Extension (Custom IG)
.... 29.111 RecallAppointmentId
.... 29.112 RecallId
.... 29.113 Booklist
.... 29.114 occupation
.... 29.115 occupationIndustry
.... 29.116 tribalAffiliation
.... 29.117 pronoun
.... 29.118 uscoresex
.... 29.119 General ValueSet Example
.... 29.120 Document type ValueSet
.... 29.121 Document class ValueSet
.... 29.122 Document format ValueSet
.... 29.123 US Core Sex
.... 29.124 General NamingSystem Example
.... 29.125 General ConceptMap Example
.... 29.126 General Account Example
.... 29.127 General AuditEvent Example
.... 29.128 General Condition Example
.... 29.129 General Condition Example
.... 29.130 General Condition Example with USCDI category SDOH
.... 29.131 General Coverage Example
.... 29.132 General Patient Example
.... 29.133 General Practitioner Example
.... 29.134 General Organization Example
.... 29.135 General Organization Example along with Endpoint Reference
.... 29.136 General PractitionerRole Example
.... 29.137 General Encounter Example for office visit
.... 29.138 General Encounter Example for lab report
.... 29.139 General Encounter Example for radiology report
.... 29.140 General MedicationRequest Example/MR
.... 29.141 General MedicationRequest Example/RX
.... 29.142 General AllergyIntolerance Example
.... 29.143 General Location Example
.... 29.144 General Device Example
.... 29.145 General FamilyMemberHistory Example
.... 29.146 General Goal Example
.... 29.147 General Goal Example for Coded SDOH Goal
.... 29.148 General ServiceRequest Example for Test order
.... 29.149 General ServiceRequest Example for Service order
.... 29.150 General ServiceRequest Example for Referral order
.... 29.151 General ServiceRequest Example for SDOH category
.... 29.152 General ServiceRequest Example for Test order with order modifier codes
.... 29.153 General ServiceRequest Example for Service order with order modifier codes
.... 29.154 General ServiceRequest Example for Referral order with order modifier codes
.... 29.155 General Specimen Example
.... 29.156 General Specimen Example For Data Absent Reason for Specimen Type Code
.... 29.157 Hemolyzed Serum Specimen Condition Example
.... 29.158 General MedicationStatement Example
.... 29.159 General DocumentReference Example
.... 29.160 General MedicationAdministration Example
.... 29.161 General MedicationDispense Example
.... 29.162 General CarePlan Example
.... 29.163 General CarePlan Example for Coded SDOH Interventions
.... 29.164 General Binary Example
.... 29.165 General Binary Example for plain text
.... 29.166 General Binary Example for rtf text
.... 29.167 Location example for room that can be scheduled for an appointment labeled as a resource in athenaPractice
.... 29.168 General Schedule Example
.... 29.169 General Medication Example
.... 29.170 General Slot Example
.... 29.171 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.172 Observation Example supporting US Core Pulse Oximetry Profile
.... 29.173 Observation Example supporting US Core Smoking Status Observation Profile
.... 29.174 Observation Example supporting US Core Pediatric BMI for Age Observation Profile
.... 29.175 Observation Example supporting US Core Pediatric Weight for Height Observation Profile
.... 29.176 Observation Example supporting US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
.... 29.177 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.178 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.179 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.180 Observation Example supporting US Core Observation Occupation Profile
.... 29.181 Observation Example supporting USCDI Tribal Affiliation
.... 29.182 Observation Example supporting USCDI Hunger Vital Sign 88122-7
.... 29.183 Observation Example supporting USCDI Hunger Vital Sign 88123-5
.... 29.184 Observation Example supporting USCDI Disability status 89571-4
.... 29.185 Observation Example sex assigned at birth
.... 29.186 Observation Example sex parameter for clinical use
.... 29.187 Observation Example with reference to specimen
.... 29.188 Observation Example for Hunger vital sign panel-88121-9
.... 29.189 Observation Example for Travel History
.... 29.190 General Immunization Example
.... 29.191 General Immunization Example for Reason Not Given
.... 29.192 General ClinicalImpression Example
.... 29.193 General Procedure Example
.... 29.194 General Procedure Example with order modifier codes
.... 29.195 General Basic example supporting $Posting Operation
.... 29.196 General CareTeam Example
.... 29.197 General RelatedPerson Example
.... 29.198 General Consent Example
.... 29.199 DiagnosticReport Example supporting US Core DiagnosticReport Lab Profile
.... 29.200 DiagnosticReport Example supporting US Core DiagnosticReport Note Profile
.... 29.201 Provenance Example supporting US Core Provenance Profile
.... 29.202 General Endpoint Example
.... 29.203 General Endpoint Example2
.... 29.204 General Bundle Example
.... 29.205 General Media Example/UltrasoundImage
.... 29.206 General Media Example/Xray
.... 29.207 Example Binary - CA-Example6
.... 29.208 Example Binary - PMA-Example5
.... 29.209 Example Binary - PPA-Example7
.... 29.210 Example Binary - PVA-Example4
.... 29.211 Example Binary - Photo-Example8
.... 29.212 Example DocumentReference - PPA-Example2
.... 29.213 Example DocumentReference - PVA-Example3
.... 29.214 Example Encounter - Example4
.... 29.215 Example MedicationRequest - Example1
.... 29.216 General Doctor Facility Organization Example
.... 29.217 General Appointment Example
.... 29.218 search parameters
.... 29.219 General RelatedPerson Guarantor Example
.... 29.220 All List Example
.... 29.221 Flowsheet List Example
.... 29.222 ValueSet List Example
.... 29.223 ConceptMap List Example
.... 29.224 NamingSystem List Example
.... 29.225 General Subscription Example