Implementation Guide
23.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 - preferredContact
.... 29.61 Extension - patientAsGuarantor
.... 29.62 Extension - genderIdentity
.... 29.63 Extension - sexualOrientation
.... 29.64 Extension - guarantorDetails
.... 29.65 Extension - SUMMARY
.... 29.66 Extension - DESCRIPTION
.... 29.67 Extension - AUTHENTICATOR
.... 29.68 MedicationRequest Extension - ddid
.... 29.69 MedicationRequest Extension - rxnorm
.... 29.70 MedicationRequest Extension - dispenser
.... 29.71 MedicationRequest Extension - dispenseInstructions
.... 29.72 MedicationRequest Extension - ndc
.... 29.73 medicationrequest Extension - datewritten
.... 29.74 MedicationAdministration Extension - rxnorm
.... 29.75 MedicationAdministration Extension - ndc
.... 29.76 MedicationAdministration Extension - ddid
.... 29.77 Extension - encounter
.... 29.78 Extension - enddate
.... 29.79 DocumentReference Extension - refprovid
.... 29.80 MedicationStatement Extension - ddid
.... 29.81 DocumentReference Extension - pubtime
.... 29.82 MedicationStatement Extension - rxnorm
.... 29.83 MedicationStatement Extension - ndc
.... 29.84 MedicationStatement Extension - medcategory
.... 29.85 Coverage Extension - coverage-type
.... 29.86 Coverage Extension - subscriber-name
.... 29.87 Slot Extension - facility
.... 29.88 Immunization Extension - VFCEligibility
.... 29.89 Posting Extension - Batch
.... 29.90 Immunization Extension - NotGiven
.... 29.91 Posting Extension - PayerName
.... 29.92 Posting Extension - patientVisitId
.... 29.93 Consent Extension - encounter
.... 29.94 Consent Extension - period
.... 29.95 Subscription Extension - owner
.... 29.96 Subscription Extension - source id
.... 29.97 Subscription Extension - source name
.... 29.98 Account Extension - patient Visit Id
.... 29.99 Account Extension - Doctor Id
.... 29.100 Account Extension - company Id
.... 29.101 Account Extension - Visit Date
.... 29.102 Account Extension - facility Id
.... 29.103 Account Extension - Bill Status
.... 29.104 Account Extension - Current Carrier
.... 29.105 Account Extension - financial Class Mid
.... 29.106 RecallAppointmentId
.... 29.107 RecallId
.... 29.108 Booklist
.... 29.109 occupation
.... 29.110 occupationIndustry
.... 29.111 tribalAffiliation
.... 29.112 pronoun
.... 29.113 uscoresex
.... 29.114 General ValueSet Example
.... 29.115 Document type ValueSet
.... 29.116 Document class ValueSet
.... 29.117 Document format ValueSet
.... 29.118 General NamingSystem Example
.... 29.119 General ConceptMap Example
.... 29.120 General Account Example
.... 29.121 General AuditEvent Example
.... 29.122 General Condition Example
.... 29.123 General Condition Example
.... 29.124 General Condition Example with USCDI category SDOH
.... 29.125 General Coverage Example
.... 29.126 General Patient Example
.... 29.127 General Practitioner Example
.... 29.128 General Organization Example
.... 29.129 General Organization Example along with Endpoint Reference
.... 29.130 General PractitionerRole Example
.... 29.131 General Encounter Example for office visit
.... 29.132 General Encounter Example for lab report
.... 29.133 General Encounter Example for radiology report
.... 29.134 General MedicationRequest Example/MR
.... 29.135 General MedicationRequest Example/RX
.... 29.136 General AllergyIntolerance Example
.... 29.137 General Location Example
.... 29.138 General Device Example
.... 29.139 General FamilyMemberHistory Example
.... 29.140 General Goal Example
.... 29.141 General Goal Example for Coded SDOH Goal
.... 29.142 General ServiceRequest Example for Test order
.... 29.143 General ServiceRequest Example for Service order
.... 29.144 General ServiceRequest Example for Referral order
.... 29.145 General ServiceRequest Example for SDOH category
.... 29.146 General ServiceRequest Example for Test order with order modifier codes
.... 29.147 General ServiceRequest Example for Service order with order modifier codes
.... 29.148 General ServiceRequest Example for Referral order with order modifier codes
.... 29.149 General Specimen Example
.... 29.150 General Specimen Example For Data Absent Reason for Specimen Type Code
.... 29.151 General MedicationStatement Example
.... 29.152 General DocumentReference Example
.... 29.153 General MedicationAdministration Example
.... 29.154 General MedicationDispense Example
.... 29.155 General CarePlan Example
.... 29.156 General CarePlan Example for Coded SDOH Interventions
.... 29.157 General Binary Example
.... 29.158 General Binary Example for plain text
.... 29.159 General Binary Example for rtf text
.... 29.160 Location example for room that can be scheduled for an appointment labeled as a resource in athenaPractice
.... 29.161 General Schedule Example
.... 29.162 General Medication Example
.... 29.163 General Slot Example
.... 29.164 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.165 Observation Example supporting US Core Pulse Oximetry Profile
.... 29.166 Observation Example supporting US Core Smoking Status Observation Profile
.... 29.167 Observation Example supporting US Core Pediatric BMI for Age Observation Profile
.... 29.168 Observation Example supporting US Core Pediatric Weight for Height Observation Profile
.... 29.169 Observation Example supporting US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
.... 29.170 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.171 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.172 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.173 Observation Example supporting US Core Observation Occupation Profile
.... 29.174 Observation Example supporting USCDI Tribal Affiliation
.... 29.175 Observation Example supporting USCDI Hunger Vital Sign 88122-7
.... 29.176 Observation Example supporting USCDI Hunger Vital Sign 88123-5
.... 29.177 Observation Example supporting USCDI Disability status 89571-4
.... 29.178 Observation Example sex assigned at birth
.... 29.179 Observation Example sex parameter for clinical use
.... 29.180 Observation Example with reference to specimen
.... 29.181 Observation Example for Hunger vital sign panel-88121-9
.... 29.182 General Immunization Example
.... 29.183 General Immunization Example for Reason Not Given
.... 29.184 General ClinicalImpression Example
.... 29.185 General Procedure Example
.... 29.186 General Procedure Example with order modifier codes
.... 29.187 General Basic example supporting $Posting Operation
.... 29.188 General CareTeam Example
.... 29.189 General RelatedPerson Example
.... 29.190 General Consent Example
.... 29.191 DiagnosticReport Example supporting US Core DiagnosticReport Lab Profile
.... 29.192 DiagnosticReport Example supporting US Core DiagnosticReport Note Profile
.... 29.193 Provenance Example supporting US Core Provenance Profile
.... 29.194 General Endpoint Example
.... 29.195 General Endpoint Example2
.... 29.196 General Bundle Example
.... 29.197 General Media Example/UltrasoundImage
.... 29.198 General Media Example/Xray
.... 29.199 Example Binary - CA-Example6
.... 29.200 Example Binary - PMA-Example5
.... 29.201 Example Binary - PPA-Example7
.... 29.202 Example Binary - PVA-Example4
.... 29.203 Example Binary - Photo-Example8
.... 29.204 Example DocumentReference - PPA-Example2
.... 29.205 Example DocumentReference - PVA-Example3
.... 29.206 Example Encounter - Example4
.... 29.207 Example MedicationRequest - Example1
.... 29.208 General Doctor Facility Organization Example
.... 29.209 General Appointment Example
.... 29.210 search parameters
.... 29.211 General RelatedPerson Guarantor Example
.... 29.212 All List Example
.... 29.213 Flowsheet List Example
.... 29.214 ValueSet List Example
.... 29.215 ConceptMap List Example
.... 29.216 NamingSystem List Example
.... 29.217 General Subscription Example