š FHIR documentation for Patient.
\n\nš”ļø **Authorization behavior:**\n- **Patients** (using `patient/*.read` scope) can access only their own Patient resource.\n- **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n- **Practitio" }, { "info": { "name": "GET /Patient/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Patient/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource" } ] }, "docs": "This interaction searches Patient based on patient id. Search interactions take patient id in path for a GET.š FHIR documentation for Patient.
\n\nš”ļø **Authorization behavior:**\n- **Patients** (using `patient/*.read` scope) can access only their own Patient resource.\n- **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n- **Practitioners** (using `user/*.read` sc" }, { "info": { "name": "Patients Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Patient/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "_id", "value": "" }, { "name": "identifier", "value": "" }, { "name": "name", "value": "" }, { "name": "birthdate", "value": "" }, { "name": "gender", "value": "" } ] } }, "docs": "This interaction searches a set of Patients based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Patient.
\n\nš”ļø **Authorization behavior:**\n- **Patients** (using `patient/*.read` scope) can access only their own Patient resource.\n- **Practitioners** (using " } ] }, { "info": { "name": "AllergyIntolerance", "type": "folder" }, "items": [ { "info": { "name": "GET /AllergyIntolerance", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/AllergyIntolerance", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who the sensitivity is for" } ] }, "docs": "This interaction searches a set of AllergyIntolerances based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for AllergyIntolerance.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one a" }, { "info": { "name": "GET /AllergyIntolerance/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/AllergyIntolerance/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches AllergyIntolerance based on allergy intolerance id.Search interactions take allergy intolerance id in path for a GET.š FHIR documentation for AllergyIntolerance.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned" }, { "info": { "name": "AllergyIntolerances Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/AllergyIntolerance/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" } ] } }, "docs": "This interaction searches a set of AllergyIntolerances based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for AllergyIntolerance.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources." } ] }, { "info": { "name": "CarePlan", "type": "folder" }, "items": [ { "info": { "name": "GET /CarePlan", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/CarePlan", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who the care plan is for" }, { "name": "category", "value": "736373009", "type": "query", "description": "Type of care plan" } ] }, "docs": "This interaction searches a set of CarePlans based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for CarePlan.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practit" }, { "info": { "name": "GET /CarePlan/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/CarePlan/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Careplan based on care plan id.Search interactions take careplan id in path for a GET.š FHIR documentation for CarePlan.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read" }, { "info": { "name": "CarePlans Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/CarePlan/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "category", "value": "" } ] } }, "docs": "This interaction searches a set of CarePlans based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for CarePlan.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using " } ] }, { "info": { "name": "CareTeam", "type": "folder" }, "items": [ { "info": { "name": "GET /CareTeam", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/CareTeam", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who care team is for" }, { "name": "status", "value": "active", "type": "query", "description": "proposed | active | suspended | inactive | entered-in-error" } ] }, "docs": "This interaction searches a set of CareTeams based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for CareTeam.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practit" }, { "info": { "name": "GET /CareTeam/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/CareTeam/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches CareTeam based on careteam id.Search interactions take care team id in path for a GET.š FHIR documentation for CareTeam.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.rea" }, { "info": { "name": "CareTeam Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/CareTeam/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "status", "value": "" } ] } }, "docs": "This interaction searches a set of CareTeam based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for CareTeam.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `" } ] }, { "info": { "name": "Condition", "type": "folder" }, "items": [ { "info": { "name": "GET /Condition", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Condition", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who condition is for" }, { "name": "category", "value": "sdoh", "type": "query", "description": "The category of the condition.\nCommon US Core Condition categories include `problem-list-item` and `encounter-diagnosis`.\nAdditional categories now supported include:\n- `sdoh` - SDOH Assessment\n- `functional-status` - Functional Status\n- `disability-status` - Disability Status\n- `cognitive-status` - Mental/Cognitive Status\n" } ] }, "docs": "This interaction searches a set of Conditions based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Condition.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n -" }, { "info": { "name": "GET /Condition/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Condition/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searche Condition based on condition id.Search interactions take condition id in path for a GET.š FHIR documentation for Condition.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `u" }, { "info": { "name": "Conditions Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Condition/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "category", "value": "" } ] } }, "docs": "This interaction searches a set of Conditions based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Condition.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners" } ] }, { "info": { "name": "DiagnosticReport", "type": "folder" }, "items": [ { "info": { "name": "GET /DiagnosticReport", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/DiagnosticReport", "params": [ { "name": "patient", "value": "", "type": "query", "description": "The subject of the report if a patient" }, { "name": "category", "value": "LAB", "type": "query", "description": "The diagnostic service category" }, { "name": "code", "value": "58410-2", "type": "query", "description": "The code for the report as defined by LOINC" }, { "name": "date", "value": "2024-06-01", "type": "query", "description": "The clinically relevant time of the report" } ] }, "docs": "This interaction searches a set of DiagnosticReports based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for DiagnosticReport.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one " }, { "info": { "name": "GET /DiagnosticReport/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/DiagnosticReport/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches DiagnosticReport based on diagnostic report id.Search interactions take diagnostic report id in path for a GET.š FHIR documentation for DiagnosticReport.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned pa" }, { "info": { "name": "DiagnosticReports Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/DiagnosticReport/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "category", "value": "" }, { "name": "code", "value": "" }, { "name": "date", "value": "" } ] } }, "docs": "This interaction searches a set of DiagnosticReports based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for DiagnosticReport.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources" } ] }, { "info": { "name": "Device", "type": "folder" }, "items": [ { "info": { "name": "GET /Device", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Device", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who device is for" } ] }, "docs": "This interaction searches a set of Devices based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Device.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **P" }, { "info": { "name": "GET /Device/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Device/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Device based on device id.Search interactions take device id in path for a GET.š FHIR documentation for Device.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.rea" }, { "info": { "name": "Device Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Device/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" } ] } }, "docs": "This interaction searches a set of Device based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Device.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (u" } ] }, { "info": { "name": "DocumentReference", "type": "folder" }, "items": [ { "info": { "name": "GET /DocumentReference", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/DocumentReference", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who/what is the subject of the document" }, { "name": "_id", "value": "153649915", "type": "query", "description": "Logical id of the document reference" }, { "name": "type", "value": "34133-9", "type": "query", "description": "Kind of document (LOINC if possible)" }, { "name": "category", "value": "clinical-note", "type": "query", "description": "Categorization of document" }, { "name": "date", "value": "2024-06-01", "type": "query", "description": "When this document reference was created" } ] }, "docs": "This interaction searches a set of DocumentReferences based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for DocumentReference.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assi" }, { "info": { "name": "GET /DocumentReference/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/DocumentReference/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches DocumentReference based on document reference id.Search interactions take document reference id in path for a GET.š FHIR documentation for DocumentReference.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned pati" }, { "info": { "name": "DocumentReferenceFetchDocref", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/DocumentReference/$docref", "params": [ { "name": "patient", "value": "6077169", "type": "query", "description": "The id of the patient resource." }, { "name": "start", "value": "2024-01-01T00:00:00Z", "type": "query", "description": "Start of the care date range for matching documents." }, { "name": "end", "value": "2024-12-31T23:59:59Z", "type": "query", "description": "End of the care date range for matching documents." }, { "name": "type", "value": "34133-9", "type": "query", "description": "Document type code such as the LOINC code for CCD." }, { "name": "on-demand", "value": "false", "type": "query", "description": "Whether to request only on-demand documents." }, { "name": "profile", "value": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference", "type": "query", "description": "Canonical profile URL used to request documents for a specific profile." } ] }, "docs": "This operation returns references to documents related to a patient and aligns to the US Core Fetch DocumentReference operation.š US Core $docref operation.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read" }, { "info": { "name": "DocumentReferences Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/DocumentReference/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "_id", "value": "" }, { "name": "type", "value": "" }, { "name": "category", "value": "" }, { "name": "date", "value": "" } ] } }, "docs": "This interaction searches a set of DocumentReferences based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for DocumentReference.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n " } ] }, { "info": { "name": "Encounter", "type": "folder" }, "items": [ { "info": { "name": "GET /Encounter", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Encounter", "params": [ { "name": "_id", "value": "5307983", "type": "query", "description": "Logical id of the encounter." }, { "name": "date", "value": "2024-06-01", "type": "query", "description": "A date within the encounter period." }, { "name": "identifier", "value": "http://example.org/encounters|ENC-5307983", "type": "query", "description": "Business identifier assigned to the encounter by the source system, visit management system, or EHR. Use token syntax `{system}|{value}` when the identifier namespace is known." }, { "name": "patient", "value": "", "type": "query", "description": "The patient present at the encounter." }, { "name": "status", "value": "finished", "type": "query", "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled" } ] }, "docs": "This interaction searches a set of Encounters based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Encounter.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Prac" }, { "info": { "name": "GET /Encounter/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Encounter/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Encounter based on encounter id.Search interactions take encounter id in path for a GET.š FHIR documentation for Encounter.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*." } ] }, { "info": { "name": "Goal", "type": "folder" }, "items": [ { "info": { "name": "GET /Goal", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Goal", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who this goal is intended for" } ] }, "docs": "This interaction searches a set of Goals based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Goal.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (us" }, { "info": { "name": "GET /Goal/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Goal/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Goal based on goal id.Search interactions take goal id in path for a GET.š FHIR documentation for Goal.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide" }, { "info": { "name": "Goal Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Goal/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" } ] } }, "docs": "This interaction searches a set of Goal based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Goal.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.re" } ] }, { "info": { "name": "Immunization", "type": "folder" }, "items": [ { "info": { "name": "GET /Immunization", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Immunization", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who this immunization is intended for" } ] }, "docs": "This interaction searches a set of Immunizations based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Immunization.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n " }, { "info": { "name": "GET /Immunization/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Immunization/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Immunization based on immunization id.Search interactions take immunization id in path for a GET.š FHIR documentation for Immunization.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** " }, { "info": { "name": "Immunizations Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Immunization/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" } ] } }, "docs": "This interaction searches a set of Immunizations based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Immunization.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitione" } ] }, { "info": { "name": "Location", "type": "folder" }, "items": [ { "info": { "name": "GET /Location", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Location", "params": [ { "name": "name", "value": "", "type": "query", "description": "A (portion of the) location's name" }, { "name": "address", "value": "", "type": "query", "description": "A (portion of the) address of the location" }, { "name": "address-city", "value": "", "type": "query", "description": "A city specified in an address" }, { "name": "address-state", "value": "", "type": "query", "description": "A state specified in an address" }, { "name": "address-postalcode", "value": "", "type": "query", "description": "A postal code specified in an address" } ] }, "docs": "This interaction searches a set of Locations based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Location.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practit" }, { "info": { "name": "GET /Location/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Location/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Location based on location id.Search interactions take location id in path for a GET.š FHIR documentation for Location.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read`" } ] }, { "info": { "name": "MedicationRequest", "type": "folder" }, "items": [ { "info": { "name": "GET /MedicationRequest", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/MedicationRequest", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Who this goal is intended for" }, { "name": "intent", "value": "order", "type": "query", "description": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option" }, { "name": "status", "value": "active", "type": "query", "description": "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown" } ] }, "docs": "This interaction searches a set of MedicationRequests based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for MedicationRequest.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assi" }, { "info": { "name": "GET /MedicationRequest/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/MedicationRequest/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches MedicationRequest based on medication request id.Search interactions take medication request id in path for a GET.š FHIR documentation for MedicationRequest.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned pati" }, { "info": { "name": "MedicationRequest Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/MedicationRequest/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "intent", "value": "" }, { "name": "status", "value": "" } ] } }, "docs": "This interaction searches a set of MedicationRequest based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for MedicationRequest.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n -" } ] }, { "info": { "name": "Observation", "type": "folder" }, "items": [ { "info": { "name": "GET /Observation", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Observation", "params": [ { "name": "patient", "value": "", "type": "query", "description": "The subject that the observation is about (if patient)" }, { "name": "category", "value": "laboratory", "type": "query", "description": "The classification of the observation. Common US Core Observation profile categories include:\n- `laboratory` ā US Core Laboratory Result Observation Profile\n- `vital-signs` ā US Core Vital Signs Profile (Blood Pressure, BMI, Body Height/Weight/Temperature, Head Circumference, Heart Rate, Pulse Oximetry, Respiratory Rate, and pediatric profiles)\n- `social-history` ā US Core Observation Occupation, Sexual Orientation, Smoking Status profiles\n- `survey` ā US Core Observation Screening Assessment, Pregnancy Intent/Status profiles\nFor screening and assessment use cases, US Core supports additional category values in addition to `survey`, including:\n- `sdoh` - SDOH Assessment\n- `functional-status` - Functional Status\n- `disability-status` - Disability Status\n- `cognitive-status` - Mental/Cognitive Status\n" }, { "name": "code", "value": "", "type": "query", "description": "The LOINC or SNOMED code of the observation type. Use token syntax `{system}|{code}` to specify a code system, or just the code value alone.\n\nCommon US Core Observation LOINC codes organized by profile:\n\n**Vital Signs:**\n- `8867-4` ā Heart rate\n- `8310-5` ā Body temperature\n- `8302-2` ā Body height\n- `29463-7` ā Body weight\n- `39156-5` ā BMI\n- `2708-6` ā Oxygen saturation\n- `9279-1` ā Respiratory rate\n- `85354-9` ā Systolic and Diastolic BP\n\n**Laboratory Results:**\n- `2345-7` ā Glucose (serum/plasma)\n- `2951-2` ā Sodium\n\n**Social History:**\n- `72166-2` ā Smoking status\n- `11341-5` ā Occupation\n\n**Sexual Orientation (US Core 6.1.0):**\n- `76690-7` ā Sexual orientation\n\n**Pregnancy (US Core 6.1.0):**\n- `82810-3` ā Pregnancy status\n- `76438-3` ā Pregnancy intent\n" }, { "name": "date", "value": "2024-06-01", "type": "query", "description": "Clinically relevant date/time of the observation. Supports prefixes `eq`, `lt`, `gt`, `ge`, `le` (e.g. `ge2024-01-01`). If the obtained element is a period, matches any date that falls within the period." }, { "name": "status", "value": "final", "type": "query", "description": "The status of the observation. Required for the `patient + category + status` SHALL search combination. Allowed values: `registered`, `preliminary`, `final`, `amended`, `corrected`, `cancelled`, `entered-in-error`, `unknown`.\n" } ] }, "docs": "This interaction searches a set of Observations based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Observation.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patien" }, { "info": { "name": "GET /Observation/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Observation/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Observation based on observation id.Search interactions take observation id in path for a GET.š FHIR documentation for Observation.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners*" }, { "info": { "name": "Observations Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Observation/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "category", "value": "" }, { "name": "code", "value": "" }, { "name": "date", "value": "" }, { "name": "status", "value": "" } ] } }, "docs": "This interaction searches a set of Observations based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Observation.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practit" } ] }, { "info": { "name": "Organization", "type": "folder" }, "items": [ { "info": { "name": "GET /Organization", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Organization", "params": [ { "name": "name", "value": "Family Medicine", "type": "query", "description": "A portion of the organization's name." }, { "name": "address", "value": "123 Main St", "type": "query", "description": "A server defined search that matches address text." } ] }, "docs": "This interaction searches a set of Organizations based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Organization.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n " }, { "info": { "name": "GET /Organization/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Organization/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Organization based on organization id.Search interactions take organization id in path for a GET.š FHIR documentation for Organization.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** " } ] }, { "info": { "name": "Practitioner", "type": "folder" }, "items": [ { "info": { "name": "GET /Practitioner", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Practitioner", "params": [ { "name": "_id", "value": "3238", "type": "query", "description": "Logical id of the practitioner." }, { "name": "identifier", "value": "http://hl7.org/fhir/sid/us-npi|1234567890", "type": "query", "description": "A practitioner business identifier such as an NPI. Use token syntax `{system}|{value}` when the identifier system is known." }, { "name": "name", "value": "Smith", "type": "query", "description": "A server defined search that may match any HumanName field." } ] }, "docs": "This interaction searches a set of Practitioners based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Practitioner.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n " }, { "info": { "name": "GET /Practitioner/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Practitioner/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Practitioner based on practitioner id.Search interactions take practitioner id in path for a GET.š FHIR documentation for Practitioner.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** " } ] }, { "info": { "name": "Procedure", "type": "folder" }, "items": [ { "info": { "name": "GET /Procedure", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Procedure", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Search by subject - a patient" }, { "name": "date", "value": "2024-06-01", "type": "query", "description": "When the procedure was performed" } ] }, "docs": "This interaction searches a set of Procedures based on some filter criteria. Search interactions take a series of query parameters for a GET.š FHIR documentation for Procedure.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Prac" }, { "info": { "name": "GET /Procedure/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Procedure/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The logical resource id associated with the Resource." } ] }, "docs": "This interaction searches Procedure based on procedure id.Search interactions take procedure id in path for a GET.š FHIR documentation for Procedure.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*." }, { "info": { "name": "Procedures Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Procedure/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "date", "value": "" } ] } }, "docs": "This interaction searches a set of Procedures based on some filter criteria. Search interactions take a series of parameters of name''=''value pairs encoded as an application/x-www-form-urlencoded submission for a POST.š FHIR documentation for Procedure.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (usi" } ] }, { "info": { "name": "Provenance", "type": "folder" }, "items": [ { "info": { "name": "GET /Provenance/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Provenance/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction searches Provenance based on provenance id.Search interactions take provenance id in path for a GET.š FHIR documentation for Provenance.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `us" } ] }, { "info": { "name": "MedicationDispense", "type": "folder" }, "items": [ { "info": { "name": "GET /MedicationDispense", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/MedicationDispense", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Returns dispenses for a specific patient" }, { "name": "status", "value": "completed", "type": "query", "description": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown" } ] }, "docs": "This interaction searches a set of MedicationDispenses based on some filter criteria. Search interactions take a series of query parameters for a GET.š US Core MedicationDispense profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned" }, { "info": { "name": "GET /MedicationDispense/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/MedicationDispense/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction retrieves a MedicationDispense resource by id.š US Core MedicationDispense profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` " }, { "info": { "name": "MedicationDispense Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/MedicationDispense/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "status", "value": "" } ] } }, "docs": "This interaction searches a set of MedicationDispenses based on some filter criteria encoded as an application/x-www-form-urlencoded submission for a POST.š US Core MedicationDispense profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one ass" } ] }, { "info": { "name": "RelatedPerson", "type": "folder" }, "items": [ { "info": { "name": "GET /RelatedPerson", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/RelatedPerson", "params": [ { "name": "patient", "value": "", "type": "query", "description": "The patient the person is related to" }, { "name": "_id", "value": "456", "type": "query", "description": "The logical resource id associated with RelatedPerson" } ] }, "docs": "This interaction searches a set of RelatedPersons based on some filter criteria. Search interactions take a series of query parameters for a GET.š US Core RelatedPerson profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - *" }, { "info": { "name": "GET /RelatedPerson/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/RelatedPerson/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction retrieves a RelatedPerson resource by id.š US Core RelatedPerson profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter" }, { "info": { "name": "RelatedPerson Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/RelatedPerson/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" }, { "name": "_id", "value": "" } ] } }, "docs": "This interaction searches a set of RelatedPersons based on some filter criteria encoded as an application/x-www-form-urlencoded submission for a POST.š US Core RelatedPerson profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n" } ] }, { "info": { "name": "Coverage", "type": "folder" }, "items": [ { "info": { "name": "GET /Coverage", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Coverage", "params": [ { "name": "patient", "value": "", "type": "query", "description": "Retrieve coverages for a patient" } ] }, "docs": "This interaction searches a set of Coverage resources based on some filter criteria. Search interactions take a series of query parameters for a GET.š US Core Coverage profile.
\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Pract" }, { "info": { "name": "GET /Coverage/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://providerapi.advancedmd.com/v1/r4/Coverage/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "patient", "value": "", "type": "query", "description": "Patient ID to filter the search." } ] }, "docs": "This interaction retrieves a Coverage resource by id.\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access anot" }, { "info": { "name": "Coverage Search using POST", "type": "http" }, "http": { "method": "POST", "url": "https://providerapi.advancedmd.com/v1/r4/Coverage/_search", "body": { "type": "form-urlencoded", "data": [ { "name": "patient", "value": "" } ] } }, "docs": "This interaction searches a set of Coverage resources based on some filter criteria encoded as an application/x-www-form-urlencoded submission for a POST.\n\nš”ļø **Authorization behavior:**\n - **Patients** (using `patient/*.read` scope) can access only their own resources.\n - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient.\n - **" } ] } ], "bundled": true }