{ "opencollection": "1.0.0", "info": { "name": "AmeriHealth Caritas AllergyIntolerance Practitioner API", "version": "1.0.0" }, "items": [ { "info": { "name": "Practitioner", "type": "folder" }, "items": [ { "info": { "name": "read-instance: Read Practitioner instance", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "read-instance: Read Practitioner instance" }, { "info": { "name": "update-instance: Update an existing Practitioner instance, or create using a client-assigned ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "update-instance: Update an existing Practitioner instance, or create using a client-assigned ID" }, { "info": { "name": "instance-patch: Patch a resource instance of type Practitioner by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 Practitioner 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/Practitioner/: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 Practitioner instance with specific version", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 Practitioner instance with specific version" }, { "info": { "name": "search-type: Search for Practitioner instances", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner", "params": [ { "name": "address-state", "value": "", "type": "query", "description": "A state specified in an address" }, { "name": "gender", "value": "", "type": "query", "description": "Gender of the practitioner" }, { "name": "resource-placeholder", "value": "", "type": "query", "description": "Search for resources of type [Practitioner] 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": "address-country", "value": "", "type": "query", "description": "A country specified in an address" }, { "name": "phonetic", "value": "", "type": "query", "description": "A portion of either family or given name using some kind of phonetic matching algorithm" }, { "name": "telecom", "value": "", "type": "query", "description": "The value in any kind of contact" }, { "name": "address-city", "value": "", "type": "query", "description": "A city specified in an address" }, { "name": "communication", "value": "", "type": "query", "description": "One of the languages that the practitioner can communicate with" }, { "name": "email", "value": "", "type": "query", "description": "A value in an email contact" }, { "name": "given", "value": "", "type": "query", "description": "A portion of the given name" }, { "name": "identifier", "value": "", "type": "query", "description": "A practitioner's Identifier" }, { "name": "address", "value": "", "type": "query", "description": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text" }, { "name": "identifier-system-prn-unique", "value": "", "type": "query" }, { "name": "_security", "value": "", "type": "query", "description": "Search for resources which have the given security labels" }, { "name": "active", "value": "", "type": "query", "description": "Whether the practitioner record is active" }, { "name": "address-postalcode", "value": "", "type": "query", "description": "A postalCode specified in an address" }, { "name": "_profile", "value": "", "type": "query", "description": "Search for resources which have the given profile" }, { "name": "phone", "value": "", "type": "query", "description": "A value in a phone contact" }, { "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": "address-use", "value": "", "type": "query", "description": "A use code specified in an address" }, { "name": "name", "value": "", "type": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text" }, { "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": "family", "value": "", "type": "query", "description": "A portion of the family name" }, { "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": "identifier-system-prn", "value": "", "type": "query", "description": "A practitioner identifier with system PRN" } ] }, "docs": "This is a search type" }, { "info": { "name": "create-type: Create a new Practitioner instance", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner", "body": { "type": "json", "data": "{}" } }, "docs": "create-type: Create a new Practitioner instance" }, { "info": { "name": "type-history: Fetch the resource change history for all resources of type Practitioner", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/_history" }, "docs": "type-history: Fetch the resource change history for all resources of type Practitioner" }, { "info": { "name": "instance-history: Fetch the resource change history for all resources of type Practitioner", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 Practitioner" }, { "info": { "name": "GET /Practitioner/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/$validate", "params": [ { "name": "resource", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /Practitioner/{id}/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 /Practitioner/{id}/$meta-delete", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 /Practitioner/{id}/$meta-add", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 /Practitioner/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/$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 /Practitioner/{id}/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 /Practitioner/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/$expunge", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Practitioner/{id}/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/:id/$expunge", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Practitioner/{id}/$graphql", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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 /Practitioner/{id}/$binary-access-write", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/:id/$binary-access-write", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Practitioner/{id}/$binary-access-read", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Practitioner/: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/Practitioner/: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 }