Implementation Guide
27.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 Da Vinci
... 7 Operations
... 8 RESTful API
... 9 Security
... 10 Delete by encounter id
... 11 Delete by context
... 12 Delete by photo
... 13 OperationDefinition
... 14 Operation: conceptmap-translate
... 15 Operation: serviceRequest-generate
... 16 Operation: documentReference-generate
... 17 Operation: documentReference-generateCDA
... 18 Operation: documentReference-docref
... 19 Operation: device-everything
... 20 Operation: Encounter-everything
... 21 Operation: Patient-everything
... 22 Operation: practitioner-everything
... 23 Operation: Patient-generate
... 24 Operation: relatedperson-everything
... 25 Operation: group-export
... 26 Operation: valueset-expand
... 27 Operation: valueset-lookup
... 28 Operation: valueset-validatecode
... 29 athena-billingstatement-profile-dataextformat
... 30 Artifacts Summary
.... 30.1 athenaPractice CapabilityStatement
.... 30.2 athenaFlow CapabilityStatement
.... 30.3 Operation - unique
.... 30.4 Profile - Athena Custom Adjustment
.... 30.5 Profile - Athena Custom BillingStatement
.... 30.6 Profile - Athena Custom Charge
.... 30.7 Profile - Athena Custom Claim
.... 30.8 Profile - Athena Custom Collection
.... 30.9 Profile - Athena Custom Deductible
.... 30.10 Profile - Athena Custom Eligibility
.... 30.11 Profile - Athena Custom PatientInsurance
.... 30.12 Profile - Athena Custom Payment
.... 30.13 Profile - Athena Custom OperationOutcome
.... 30.14 Profile - Athena Condition
.... 30.15 Profile - Athena Patient
.... 30.16 Profile - Athena Organization
.... 30.17 Profile - Athena Practitioner
.... 30.18 Profile - Athena PractitionerRole
.... 30.19 Profile - Athena Encounter
.... 30.20 Profile - Athena MedRequest
.... 30.21 Profile - Athena AllergyIntolerance
.... 30.22 Profile - Athena Location
.... 30.23 Profile - Athena Device
.... 30.24 Profile - Athena FamilyMemberHistory
.... 30.25 Profile - Athena Goal
.... 30.26 Profile - Athena DocumentReference
.... 30.27 Profile - Athena ServiceRequest
.... 30.28 Profile - Athena Specimen
.... 30.29 Profile - Athena MedicationStatement
.... 30.30 Profile - Athena MedicationAdministration
.... 30.31 Profile - Athena MedicationDispense
.... 30.32 Profile - Athena CarePlan
.... 30.33 Profile - Athena Binary
.... 30.34 Profile - Athena Slot
.... 30.35 Profile - Athena Appointment
.... 30.36 Profile - Athena Coverage
.... 30.37 Profile - Athena Schedule
.... 30.38 Profile - Athena Medication
.... 30.39 Profile - Athena Posting
.... 30.40 Profile - Athena Observation
.... 30.41 Profile - Athena Immunization
.... 30.42 Profile - Athena AuditEvent
.... 30.43 Profile - Athena ClinicalImpression
.... 30.44 Profile - Athena CareTeam
.... 30.45 Profile - Athena RelatedPerson
.... 30.46 Profile - Athena Consent
.... 30.47 Profile - Athena Procedure
.... 30.48 Profile - Athena DiagnosticReport
.... 30.49 Profile - Athena Provenance
.... 30.50 Profile - Athena Subscription
.... 30.51 Profile - Athena Account
.... 30.52 Profile - Athena Endpoint
.... 30.53 Profile - Athena Media
.... 30.54 Profile - Athena PAS Service Request
.... 30.55 Profile - Athena PAS Subscriber Patient
.... 30.56 Profile - Athena PAS Insurer Organization
.... 30.57 Profile - Athena PAS Beneficiary Patient
.... 30.58 Profile - Athena PAS Encounter
.... 30.59 Profile - Athena PAS Requestor Organization
.... 30.60 AthenaConceptMap
.... 30.61 AthenaList
.... 30.62 AthenaNamingSystem
.... 30.63 AthenaValueSet
.... 30.64 Extension - RESPPROVID
.... 30.65 Extension - REFDOCID
.... 30.66 Extension - educationProvided
.... 30.67 extension - BIRTHTIME
.... 30.68 Extension - preferredContact
.... 30.69 Extension - patientAsGuarantor
.... 30.70 Extension - genderIdentity
.... 30.71 Extension - sexualOrientation
.... 30.72 Extension - guarantorDetails
.... 30.73 Extension - SUMMARY
.... 30.74 Extension - DESCRIPTION
.... 30.75 Extension - AUTHENTICATOR
.... 30.76 MedicationRequest Extension - ddid
.... 30.77 MedicationRequest Extension - rxnorm
.... 30.78 MedicationRequest Extension - dispenser
.... 30.79 MedicationRequest Extension - dispenseInstructions
.... 30.80 MedicationRequest Extension - ndc
.... 30.81 medicationrequest Extension - datewritten
.... 30.82 MedicationAdministration Extension - rxnorm
.... 30.83 MedicationAdministration Extension - ndc
.... 30.84 MedicationAdministration Extension - ddid
.... 30.85 Extension - encounter
.... 30.86 Extension - enddate
.... 30.87 DocumentReference Extension - refprovid
.... 30.88 MedicationStatement Extension - ddid
.... 30.89 DocumentReference Extension - pubtime
.... 30.90 MedicationStatement Extension - rxnorm
.... 30.91 MedicationStatement Extension - ndc
.... 30.92 MedicationStatement Extension - medcategory
.... 30.93 Coverage Extension - coverage-type
.... 30.94 Coverage Extension - subscriber-name
.... 30.95 Slot Extension - facility
.... 30.96 Immunization Extension - VFCEligibility
.... 30.97 Posting Extension - Batch
.... 30.98 Immunization Extension - NotGiven
.... 30.99 Posting Extension - PayerName
.... 30.100 Posting Extension - patientVisitId
.... 30.101 Consent Extension - encounter
.... 30.102 Consent Extension - period
.... 30.103 Subscription Extension - owner
.... 30.104 Subscription Extension - source id
.... 30.105 Subscription Extension - source name
.... 30.106 Account Extension - patient Visit Id
.... 30.107 Account Extension - Doctor Id
.... 30.108 Account Extension - company Id
.... 30.109 Account Extension - Visit Date
.... 30.110 Account Extension - facility Id
.... 30.111 Account Extension - Bill Status
.... 30.112 Account Extension - Current Carrier
.... 30.113 Account Extension - financial Class Mid
.... 30.114 Coverage Information Extension
.... 30.115 Gender Identity
.... 30.116 Identifier Jurisdiction
.... 30.117 Identifier SubDepartment
.... 30.118 Military Status
.... 30.119 Nursing Home Residential Status
.... 30.120 Patient Status
.... 30.121 Product or Service Code End
.... 30.122 Tribal Affiliation
.... 30.123 US Core Birth Sex
.... 30.124 US Core Sex
.... 30.125 Pronouns Extension
.... 30.126 US Core Sex for Clinical Use Extension (Custom IG)
.... 30.127 US Core Tribal Affiliation Extension (Custom IG)
.... 30.128 RecallAppointmentId
.... 30.129 RecallId
.... 30.130 Booklist
.... 30.131 occupation
.... 30.132 occupationIndustry
.... 30.133 tribalAffiliation
.... 30.134 pronoun
.... 30.135 uscoresex
.... 30.136 General ValueSet Example
.... 30.137 Document type ValueSet
.... 30.138 Document class ValueSet
.... 30.139 Document format ValueSet
.... 30.140 US Core Sex
.... 30.141 General NamingSystem Example
.... 30.142 General ConceptMap Example
.... 30.143 General Account Example
.... 30.144 General AuditEvent Example
.... 30.145 General Condition Example
.... 30.146 General Condition Example
.... 30.147 General Condition Example with USCDI category SDOH
.... 30.148 General Coverage Example
.... 30.149 General Patient Example
.... 30.150 General Practitioner Example
.... 30.151 General Organization Example
.... 30.152 General Organization Example along with Endpoint Reference
.... 30.153 General PractitionerRole Example
.... 30.154 General Encounter Example for office visit
.... 30.155 General Encounter Example for lab report
.... 30.156 General Encounter Example for radiology report
.... 30.157 General MedicationRequest Example/MR
.... 30.158 General MedicationRequest Example/RX
.... 30.159 General AllergyIntolerance Example
.... 30.160 General Location Example
.... 30.161 General Device Example
.... 30.162 General FamilyMemberHistory Example
.... 30.163 General Goal Example
.... 30.164 General Goal Example for Coded SDOH Goal
.... 30.165 General ServiceRequest Example for Test order
.... 30.166 General ServiceRequest Example for Service order
.... 30.167 General ServiceRequest Example for Referral order
.... 30.168 General ServiceRequest Example for SDOH category
.... 30.169 General ServiceRequest Example for Test order with order modifier codes
.... 30.170 General ServiceRequest Example for Service order with order modifier codes
.... 30.171 General ServiceRequest Example for Referral order with order modifier codes
.... 30.172 PAS Service Request Example
.... 30.173 PAS Encounter Example
.... 30.174 PAS Insurer Organization Example
.... 30.175 PAS Subscriber Patient Example
.... 30.176 PAS Beneficiary Patient Example
.... 30.177 PAS Requestor Organization Example
.... 30.178 General Specimen Example
.... 30.179 General Specimen Example For Data Absent Reason for Specimen Type Code
.... 30.180 Hemolyzed Serum Specimen Condition Example
.... 30.181 General MedicationStatement Example
.... 30.182 General DocumentReference Example
.... 30.183 General MedicationAdministration Example
.... 30.184 General MedicationDispense Example
.... 30.185 General CarePlan Example
.... 30.186 General CarePlan Example for Coded SDOH Interventions
.... 30.187 General Binary Example
.... 30.188 General Binary Example for plain text
.... 30.189 General Binary Example for rtf text
.... 30.190 Location example for room that can be scheduled for an appointment labeled as a resource in athenaPractice
.... 30.191 General Schedule Example
.... 30.192 General Medication Example
.... 30.193 General Slot Example
.... 30.194 Observation Example supporting US Core Laboratory Result Observation Profile
.... 30.195 Observation Example supporting US Core Pulse Oximetry Profile
.... 30.196 Observation Example supporting US Core Smoking Status Observation Profile
.... 30.197 Observation Example supporting US Core Pediatric BMI for Age Observation Profile
.... 30.198 Observation Example supporting US Core Pediatric Weight for Height Observation Profile
.... 30.199 Observation Example supporting US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
.... 30.200 Observation Example supporting US Core Laboratory Result Observation Profile
.... 30.201 Observation Example supporting US Core Laboratory Result Observation Profile
.... 30.202 Observation Example supporting US Core Laboratory Result Observation Profile
.... 30.203 Observation Example supporting US Core Observation Occupation Profile
.... 30.204 Observation Example supporting USCDI Tribal Affiliation
.... 30.205 Observation Example supporting USCDI Hunger Vital Sign 88122-7
.... 30.206 Observation Example supporting USCDI Hunger Vital Sign 88123-5
.... 30.207 Observation Example supporting USCDI Disability status 89571-4
.... 30.208 Observation Example sex assigned at birth
.... 30.209 Observation Example sex parameter for clinical use
.... 30.210 Observation Example with reference to specimen
.... 30.211 Observation Example for Hunger vital sign panel-88121-9
.... 30.212 Observation Example for Travel History
.... 30.213 General Immunization Example
.... 30.214 General Immunization Example for Reason Not Given
.... 30.215 General ClinicalImpression Example
.... 30.216 General Procedure Example
.... 30.217 General Procedure Example with order modifier codes
.... 30.218 General Basic example supporting $Posting Operation
.... 30.219 General CareTeam Example
.... 30.220 General RelatedPerson Example
.... 30.221 General Consent Example
.... 30.222 DiagnosticReport Example supporting US Core DiagnosticReport Lab Profile
.... 30.223 DiagnosticReport Example supporting US Core DiagnosticReport Note Profile
.... 30.224 Provenance Example supporting US Core Provenance Profile
.... 30.225 General Endpoint Example
.... 30.226 General Endpoint Example2
.... 30.227 General Bundle Example
.... 30.228 General Media Example/UltrasoundImage
.... 30.229 General Media Example/Xray
.... 30.230 Example Binary - CA-Example6
.... 30.231 Example Binary - PMA-Example5
.... 30.232 Example Binary - PPA-Example7
.... 30.233 Example Binary - PVA-Example4
.... 30.234 Example Binary - Photo-Example8
.... 30.235 Example DocumentReference - PPA-Example2
.... 30.236 Example DocumentReference - PVA-Example3
.... 30.237 Example Encounter - Example4
.... 30.238 Example MedicationRequest - Example1
.... 30.239 General Doctor Facility Organization Example
.... 30.240 General Appointment Example
.... 30.241 search parameters
.... 30.242 General RelatedPerson Guarantor Example
.... 30.243 All List Example
.... 30.244 Flowsheet List Example
.... 30.245 ValueSet List Example
.... 30.246 ConceptMap List Example
.... 30.247 NamingSystem List Example
.... 30.248 General Subscription Example