{ "opencollection": "1.0.0", "info": { "name": "AmeriHealth Caritas AllergyIntolerance Patient API", "version": "1.0.0" }, "items": [ { "info": { "name": "Patient", "type": "folder" }, "items": [ { "info": { "name": "read-instance: Read Patient instance", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "read-instance: Read Patient instance" }, { "info": { "name": "update-instance: Update an existing Patient instance, or create using a client-assigned ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/:id", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "update-instance: Update an existing Patient instance, or create using a client-assigned ID" }, { "info": { "name": "instance-patch: Patch a resource instance of type Patient by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 Patient 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/Patient/: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 Patient instance with specific version", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 Patient instance with specific version" }, { "info": { "name": "search-type: Search for Patient instances", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient", "params": [ { "name": "deceased", "value": "", "type": "query", "description": "This patient has been marked as deceased, or as a death date entered" }, { "name": "birthdate", "value": "", "type": "query", "description": "The patient's date of birth" }, { "name": "gender", "value": "", "type": "query", "description": "Gender of the patient" }, { "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 [Patient] 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": "link", "value": "", "type": "query", "description": "All patients linked to the given patient" }, { "name": "language", "value": "", "type": "query", "description": "Language code (irrespective of use value)" }, { "name": "address-country", "value": "", "type": "query", "description": "A country specified in an address" }, { "name": "death-date", "value": "", "type": "query", "description": "The date of death has been provided and satisfies this search value" }, { "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 telecom details of the patient" }, { "name": "address-city", "value": "", "type": "query", "description": "A city specified in an address" }, { "name": "email", "value": "", "type": "query", "description": "A value in an email contact" }, { "name": "identifier-system-mb", "value": "", "type": "query", "description": "A patient identifier with system MB" }, { "name": "identifier", "value": "", "type": "query", "description": "A patient identifier" }, { "name": "given", "value": "", "type": "query", "description": "A portion of the given name of the patient" }, { "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": "staffFlag", "value": "", "type": "query", "description": "Boolean flag declaring if member is a member of staff" }, { "name": "general-practitioner", "value": "", "type": "query", "description": "Patient's nominated general practitioner, not the organization that manages the record" }, { "name": "_security", "value": "", "type": "query", "description": "Search for resources which have the given security labels" }, { "name": "active", "value": "", "type": "query", "description": "Whether the patient record is active" }, { "name": "address-postalcode", "value": "", "type": "query", "description": "A postalCode specified in an address" }, { "name": "identifier-system-mb-unique", "value": "", "type": "query" }, { "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": "organization", "value": "", "type": "query", "description": "The organization that is the custodian of the patient record" }, { "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 of the patient" }, { "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" } ] }, "docs": "This is a search type" }, { "info": { "name": "create-type: Create a new Patient instance", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient", "body": { "type": "json", "data": "{}" } }, "docs": "create-type: Create a new Patient instance" }, { "info": { "name": "type-history: Fetch the resource change history for all resources of type Patient", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/_history" }, "docs": "type-history: Fetch the resource change history for all resources of type Patient" }, { "info": { "name": "instance-history: Fetch the resource change history for all resources of type Patient", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 Patient" }, { "info": { "name": "POST /Patient/$member-match", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/$member-match", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Patient/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/$validate", "params": [ { "name": "resource", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /Patient/{id}/$validate", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 /Patient/{id}/$meta-delete", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 /Patient/{id}/$meta-add", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 /Patient/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/$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 /Patient/{id}/$meta", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 /Patient/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/$expunge", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Patient/{id}/$expunge", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/:id/$expunge", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Patient/$everything", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/$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 /Patient/{id}/$everything", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 /Patient/{id}/$graphql", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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 /Patient/{id}/$binary-access-write", "type": "http" }, "http": { "method": "POST", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/:id/$binary-access-write", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Patient/{id}/$binary-access-read", "type": "http" }, "http": { "method": "GET", "url": "https://api-ext.amerihealthcaritas.com/0500/patient-api/Patient/: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/Patient/: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 }