{ "opencollection": "1.0.0", "info": { "name": "AmeriHealth Caritas AllergyIntolerance Location API", "version": "1.0.0" }, "items": [ { "info": { "name": "Location", "type": "folder" }, "items": [ { "info": { "name": "read-instance: Read Location instance", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "read-instance: Read Location instance" }, { "info": { "name": "update-instance: Update an existing Location instance, or create using a client-assigned ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "update-instance: Update an existing Location instance, or create using a client-assigned ID" }, { "info": { "name": "instance-patch: Patch a resource instance of type Location by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 Location 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/Location/: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 Location instance with specific version", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 Location instance with specific version" }, { "info": { "name": "search-type: Search for Location instances", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location", "params": [ { "name": "address-state", "value": "", "type": "query", "description": "A state specified in an address" }, { "name": "resource-placeholder", "value": "", "type": "query", "description": "Search for resources of type [Location] 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": "operational-status", "value": "", "type": "query", "description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)" }, { "name": "identifier-system-loc", "value": "", "type": "query", "description": "A location identifier with system LOC" }, { "name": "type", "value": "", "type": "query", "description": "A code for the type of location" }, { "name": "address-country", "value": "", "type": "query", "description": "A country specified in an address" }, { "name": "endpoint", "value": "", "type": "query", "description": "Technical endpoints providing access to services operated for the location" }, { "name": "near", "value": "", "type": "query", "description": "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also" }, { "name": "address-city", "value": "", "type": "query", "description": "A city specified in an address" }, { "name": "partof", "value": "", "type": "query", "description": "A location of which this location is a part" }, { "name": "identifier", "value": "", "type": "query", "description": "An identifier for the location" }, { "name": "address", "value": "", "type": "query", "description": "A (part of the) address of the location" }, { "name": "_security", "value": "", "type": "query", "description": "Search for resources which have the given security labels" }, { "name": "address-postalcode", "value": "", "type": "query", "description": "A postal code specified in an address" }, { "name": "identifier-system-loc-unique", "value": "", "type": "query" }, { "name": "_profile", "value": "", "type": "query", "description": "Search for resources which have the given profile" }, { "name": "organization", "value": "", "type": "query", "description": "Searches for locations that are managed by the provided organization" }, { "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": "name", "value": "", "type": "query", "description": "A portion of the location's name or alias" }, { "name": "address-use", "value": "", "type": "query", "description": "A use code specified in an address" }, { "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": "status", "value": "", "type": "query", "description": "Searches for locations with a specific kind of status" } ] }, "docs": "This is a search type" }, { "info": { "name": "create-type: Create a new Location instance", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location", "body": { "type": "json", "data": "{}" } }, "docs": "create-type: Create a new Location instance" }, { "info": { "name": "type-history: Fetch the resource change history for all resources of type Location", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/_history" }, "docs": "type-history: Fetch the resource change history for all resources of type Location" }, { "info": { "name": "instance-history: Fetch the resource change history for all resources of type Location", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 Location" }, { "info": { "name": "GET /Location/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/$validate", "params": [ { "name": "resource", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /Location/{id}/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 /Location/{id}/$meta-delete", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 /Location/{id}/$meta-add", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 /Location/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/$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 /Location/{id}/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 /Location/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/$expunge", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Location/{id}/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/:id/$expunge", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Location/{id}/$graphql", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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 /Location/{id}/$binary-access-write", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/:id/$binary-access-write", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Location/{id}/$binary-access-read", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Location/: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/Location/: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 }