Implementation Guide
23.1.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 Condition
.... 29.14 Profile - Athena Patient
.... 29.15 Profile - Athena Organization
.... 29.16 Profile - Athena Practitioner
.... 29.17 Profile - Athena PractitionerRole
.... 29.18 Profile - Athena Encounter
.... 29.19 Profile - Athena MedRequest
.... 29.20 Profile - Athena AllergyIntolerance
.... 29.21 Profile - Athena Location
.... 29.22 Profile - Athena Device
.... 29.23 Profile - Athena FamilyMemberHistory
.... 29.24 Profile - Athena Goal
.... 29.25 Profile - Athena DocumentReference
.... 29.26 Profile - Athena ServiceRequest
.... 29.27 Profile - Athena MedicationStatement
.... 29.28 Profile - Athena MedicationAdministration
.... 29.29 Profile - Athena CarePlan
.... 29.30 Profile - Athena Binary
.... 29.31 Profile - Athena Slot
.... 29.32 Profile - Athena Appointment
.... 29.33 Profile - Athena Coverage
.... 29.34 Profile - Athena Schedule
.... 29.35 Profile - Athena Medication
.... 29.36 Profile - Athena Posting
.... 29.37 Profile - Athena Observation
.... 29.38 Profile - Athena Immunization
.... 29.39 Profile - Athena AuditEvent
.... 29.40 Profile - Athena ClinicalImpression
.... 29.41 Profile - Athena CareTeam
.... 29.42 Profile - Athena RelatedPerson
.... 29.43 Profile - Athena Consent
.... 29.44 Profile - Athena Procedure
.... 29.45 Profile - Athena DiagnosticReport
.... 29.46 Profile - Athena Provenance
.... 29.47 Profile - Athena Subscription
.... 29.48 Profile - Athena Account
.... 29.49 Profile - Athena Endpoint
.... 29.50 AthenaConceptMap
.... 29.51 AthenaList
.... 29.52 AthenaNamingSystem
.... 29.53 AthenaValueSet
.... 29.54 Extension - RESPPROVID
.... 29.55 Extension - REFDOCID
.... 29.56 Extension - preferredContact
.... 29.57 Extension - patientAsGuarantor
.... 29.58 Extension - genderIdentity
.... 29.59 Extension - sexualOrientation
.... 29.60 Extension - guarantorDetails
.... 29.61 Extension - SUMMARY
.... 29.62 Extension - DESCRIPTION
.... 29.63 Extension - AUTHENTICATOR
.... 29.64 MedicationRequest Extension - ddid
.... 29.65 MedicationRequest Extension - rxnorm
.... 29.66 MedicationRequest Extension - dispenser
.... 29.67 MedicationRequest Extension - dispenseInstructions
.... 29.68 MedicationRequest Extension - ndc
.... 29.69 medicationrequest Extension - datewritten
.... 29.70 MedicationAdministration Extension - rxnorm
.... 29.71 MedicationAdministration Extension - ndc
.... 29.72 MedicationAdministration Extension - ddid
.... 29.73 Extension - encounter
.... 29.74 Extension - enddate
.... 29.75 DocumentReference Extension - refprovid
.... 29.76 MedicationStatement Extension - ddid
.... 29.77 DocumentReference Extension - pubtime
.... 29.78 MedicationStatement Extension - rxnorm
.... 29.79 MedicationStatement Extension - ndc
.... 29.80 MedicationStatement Extension - medcategory
.... 29.81 Coverage Extension - coverage-type
.... 29.82 Coverage Extension - subscriber-name
.... 29.83 Slot Extension - facility
.... 29.84 Immunization Extension - VFCEligibility
.... 29.85 Posting Extension - Batch
.... 29.86 Immunization Extension - NotGiven
.... 29.87 Posting Extension - PayerName
.... 29.88 Posting Extension - patientVisitId
.... 29.89 Consent Extension - encounter
.... 29.90 Consent Extension - period
.... 29.91 Subscription Extension - owner
.... 29.92 Subscription Extension - source id
.... 29.93 Subscription Extension - source name
.... 29.94 Account Extension - patient Visit Id
.... 29.95 Account Extension - Doctor Id
.... 29.96 Account Extension - company Id
.... 29.97 Account Extension - Visit Date
.... 29.98 Account Extension - facility Id
.... 29.99 Account Extension - Bill Status
.... 29.100 Account Extension - Current Carrier
.... 29.101 Account Extension - financial Class Mid
.... 29.102 RecallAppointmentId
.... 29.103 RecallId
.... 29.104 Booklist
.... 29.105 General ValueSet Example
.... 29.106 Document type ValueSet
.... 29.107 Document class ValueSet
.... 29.108 Document format ValueSet
.... 29.109 General NamingSystem Example
.... 29.110 General ConceptMap Example
.... 29.111 General Account Example
.... 29.112 General AuditEvent Example
.... 29.113 General Condition Example
.... 29.114 General Coverage Example
.... 29.115 General Patient Example
.... 29.116 General Practitioner Example
.... 29.117 General Organization Example
.... 29.118 General PractitionerRole Example
.... 29.119 General Encounter Example for office visit
.... 29.120 General Encounter Example for lab report
.... 29.121 General Encounter Example for radiology report
.... 29.122 General MedicationRequest Example/MR
.... 29.123 General MedicationRequest Example/RX
.... 29.124 General AllergyIntolerance Example
.... 29.125 General Location Example
.... 29.126 General Device Example
.... 29.127 General FamilyMemberHistory Example
.... 29.128 General Goal Example
.... 29.129 General ServiceRequest Example for Test order
.... 29.130 General ServiceRequest Example for Service order
.... 29.131 General ServiceRequest Example for Referral order
.... 29.132 General MedicationStatement Example
.... 29.133 General DocumentReference Example
.... 29.134 General MedicationAdministration Example
.... 29.135 General CarePlan Example
.... 29.136 General Binary Example
.... 29.137 General Binary Example for plain text
.... 29.138 General Binary Example for rtf text
.... 29.139 Location example for room that can be scheduled for an appointment labeled as a resource in athenaPractice
.... 29.140 General Schedule Example
.... 29.141 General Medication Example
.... 29.142 General Slot Example
.... 29.143 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.144 Observation Example supporting US Core Pulse Oximetry Profile
.... 29.145 Observation Example supporting US Core Smoking Status Observation Profile
.... 29.146 Observation Example supporting US Core Pediatric BMI for Age Observation Profile
.... 29.147 Observation Example supporting US Core Pediatric Weight for Height Observation Profile
.... 29.148 Observation Example supporting US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
.... 29.149 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.150 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.151 Observation Example supporting US Core Laboratory Result Observation Profile
.... 29.152 General Immunization Example
.... 29.153 General Immunization Example for Reason Not Given
.... 29.154 General ClinicalImpression Example
.... 29.155 General Procedure Example
.... 29.156 General Basic example supporting $Posting Operation
.... 29.157 General CareTeam Example
.... 29.158 General RelatedPerson Example
.... 29.159 General Consent Example
.... 29.160 DiagnosticReport Example supporting US Core DiagnosticReport Lab Profile
.... 29.161 DiagnosticReport Example supporting US Core DiagnosticReport Note Profile
.... 29.162 Provenance Example supporting US Core Provenance Profile
.... 29.163 General Endpoint Example
.... 29.164 Example MedicationRequest - Example1
.... 29.165 General Doctor Facility Organization Example
.... 29.166 General Appointment Example
.... 29.167 search parameters
.... 29.168 General RelatedPerson Guarantor Example
.... 29.169 All List Example
.... 29.170 Flowsheet List Example
.... 29.171 ValueSet List Example
.... 29.172 ConceptMap List Example
.... 29.173 NamingSystem List Example
.... 29.174 General Subscription Example