{ "opencollection": "1.0.0", "info": { "name": "AmeriHealth Caritas AllergyIntolerance Encounter API", "version": "1.0.0" }, "items": [ { "info": { "name": "Encounter", "type": "folder" }, "items": [ { "info": { "name": "read-instance: Read Encounter instance", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "read-instance: Read Encounter instance" }, { "info": { "name": "update-instance: Update an existing Encounter instance, or create using a client-assigned ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "update-instance: Update an existing Encounter instance, or create using a client-assigned ID" }, { "info": { "name": "instance-patch: Patch a resource instance of type Encounter by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "instance-patch: Patch a resource instance of type Encounter by ID" }, { "info": { "name": "instance-delete: Perform a logical delete on a resource instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "instance-delete: Perform a logical delete on a resource instance" }, { "info": { "name": "vread-instance: Read Encounter instance with specific version", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/_history/:version_id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "version_id", "value": "1", "type": "path", "description": "The resource version ID" } ] }, "docs": "vread-instance: Read Encounter instance with specific version" }, { "info": { "name": "search-type: Search for Encounter instances", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter", "params": [ { "name": "date", "value": "", "type": "query", "description": "A date within the period the Encounter lasted" }, { "name": "participant-type", "value": "", "type": "query", "description": "Role of participant in encounter" }, { "name": "subject", "value": "", "type": "query", "description": "The patient or group present at the encounter" }, { "name": "resource-placeholder", "value": "", "type": "query", "description": "Search for resources of type [Encounter] populated with the resource-placeholder extension" }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "Only return resources which were last updated as specified by the given range" }, { "name": "appointment", "value": "", "type": "query", "description": "The appointment that scheduled this encounter" }, { "name": "part-of", "value": "", "type": "query", "description": "Another Encounter this encounter is part of" }, { "name": "type", "value": "", "type": "query", "description": "Specific type of encounter" }, { "name": "participant", "value": "", "type": "query", "description": "Persons involved in the encounter other than the patient" }, { "name": "reason-code", "value": "", "type": "query", "description": "Coded reason the encounter takes place" }, { "name": "based-on", "value": "", "type": "query", "description": "The ServiceRequest that initiated this encounter" }, { "name": "patient", "value": "", "type": "query", "description": "The patient or group present at the encounter" }, { "name": "identifier-system-tx-unique", "value": "", "type": "query" }, { "name": "location-period", "value": "", "type": "query", "description": "Time period during which the patient was present at the location" }, { "name": "special-arrangement", "value": "", "type": "query", "description": "Wheelchair, translator, stretcher, etc." }, { "name": "class", "value": "", "type": "query", "description": "Classification of patient encounter" }, { "name": "identifier", "value": "", "type": "query", "description": "Identifier(s) by which this encounter is known" }, { "name": "practitioner", "value": "", "type": "query", "description": "Persons involved in the encounter other than the patient" }, { "name": "episode-of-care", "value": "", "type": "query", "description": "Episode(s) of care that this encounter should be recorded against" }, { "name": "length", "value": "", "type": "query", "description": "Length of encounter in days" }, { "name": "_security", "value": "", "type": "query", "description": "Search for resources which have the given security labels" }, { "name": "diagnosis", "value": "", "type": "query", "description": "The diagnosis or procedure relevant to the encounter" }, { "name": "identifier-system-tx", "value": "", "type": "query", "description": "An encounter identifier with system TX" }, { "name": "_profile", "value": "", "type": "query", "description": "Search for resources which have the given profile" }, { "name": "_has", "value": "", "type": "query", "description": "Return resources linked to by the given target" }, { "name": "_tag", "value": "", "type": "query", "description": "Search for resources which have the given tag" }, { "name": "reason-reference", "value": "", "type": "query", "description": "Reason the encounter takes place (reference)" }, { "name": "service-provider", "value": "", "type": "query", "description": "The organization (facility) responsible for this encounter" }, { "name": "location", "value": "", "type": "query", "description": "Location the encounter takes place" }, { "name": "_source", "value": "", "type": "query", "description": "Search for resources which have the given source value (Resource.meta.source)" }, { "name": "_id", "value": "", "type": "query", "description": "The ID of the resource" }, { "name": "_content", "value": "", "type": "query", "description": "Search the contents of the resource's data using a fulltext search" }, { "name": "_text", "value": "", "type": "query", "description": "Search the contents of the resource's narrative using a fulltext search" }, { "name": "account", "value": "", "type": "query", "description": "The set of accounts that may be used for billing for this Encounter" }, { "name": "status", "value": "", "type": "query", "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +" } ] }, "docs": "This is a search type" }, { "info": { "name": "create-type: Create a new Encounter instance", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter", "body": { "type": "json", "data": "{}" } }, "docs": "create-type: Create a new Encounter instance" }, { "info": { "name": "type-history: Fetch the resource change history for all resources of type Encounter", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/_history" }, "docs": "type-history: Fetch the resource change history for all resources of type Encounter" }, { "info": { "name": "instance-history: Fetch the resource change history for all resources of type Encounter", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/_history", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "instance-history: Fetch the resource change history for all resources of type Encounter" }, { "info": { "name": "GET /Encounter/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/$validate", "params": [ { "name": "resource", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /Encounter/{id}/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$validate", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "resource", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /Encounter/{id}/$meta-delete", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$meta-delete", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete tags, profiles, and/or security labels from a resource" }, { "info": { "name": "POST /Encounter/{id}/$meta-add", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$meta-add", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add tags, profiles, and/or security labels to a resource" }, { "info": { "name": "GET /Encounter/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/$meta", "params": [ { "name": "return", "value": "", "type": "query" } ] }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "GET /Encounter/{id}/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$meta", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "return", "value": "", "type": "query" } ] }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "POST /Encounter/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/$expunge", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Encounter/{id}/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$expunge", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Encounter/$everything", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/$everything", "params": [ { "name": "_count", "value": "", "type": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages." }, { "name": "_offset", "value": "", "type": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page." }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "Only return resources which were last updated as specified by the given range" }, { "name": "_content", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _content filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_text", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _text filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_filter", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _filter filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_type", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _type filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_id", "value": "", "type": "query", "description": "Filter the resources to return based on the patient ids provided." } ] } }, { "info": { "name": "GET /Encounter/{id}/$everything", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$everything", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "_count", "value": "", "type": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages." }, { "name": "_offset", "value": "", "type": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page." }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "Only return resources which were last updated as specified by the given range" }, { "name": "_content", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _content filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_text", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _text filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_filter", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _filter filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_type", "value": "", "type": "query", "description": "Filter the resources to return only resources matching the given _type filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)" }, { "name": "_id", "value": "", "type": "query", "description": "Filter the resources to return based on the patient ids provided." } ] } }, { "info": { "name": "GET /Encounter/{id}/$graphql", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$graphql", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format." }, { "info": { "name": "POST /Encounter/{id}/$binary-access-write", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$binary-access-write", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Encounter/{id}/$binary-access-read", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$binary-access-read", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "path", "value": "", "type": "query" } ] } }, { "info": { "name": "Comparte two resources or two versions of a single resource", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Encounter/:id/$diff", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "from", "value": "Patient/example/version/1", "type": "query", "description": "The resource ID and version to diff from" }, { "name": "to", "value": "Patient/example/version/2", "type": "query", "description": "The resource ID and version to diff to" }, { "name": "includeMeta", "value": "false", "type": "query", "description": "Should differences in the Resource.meta element be included in the diff" }, { "name": "fromVersion", "value": "Patient/example/version/1", "type": "query", "description": "The resource ID and version to diff from" } ] }, "docs": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences." } ] } ], "bundled": true }