{ "opencollection": "1.0.0", "info": { "name": "Untitled CodeSystem Practitioner API", "version": "unspecified" }, "items": [ { "info": { "name": "Practitioner", "type": "folder" }, "items": [ { "info": { "name": "read-instance: Read Practitioner instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/Practitioner", "params": [ { "name": "address-state", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address" }, { "name": "gender", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person" }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "When the resource version last changed" }, { "name": "address-country", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address" }, { "name": "phonetic", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm" }, { "name": "telecom", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" }, { "name": "address-city", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): 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": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" }, { "name": "given", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name" }, { "name": "identifier", "value": "", "type": "query", "description": "A practitioner's Identifier
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" }, { "name": "address", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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": "_security", "value": "", "type": "query", "description": "Security Labels applied to this resource" }, { "name": "active", "value": "", "type": "query", "description": "Whether the practitioner record is active" }, { "name": "address-postalcode", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address" }, { "name": "_filter", "value": "", "type": "query", "description": "Search the contents of the resource's data using a filter" }, { "name": "_profile", "value": "", "type": "query", "description": "Profiles this resource claims to conform to" }, { "name": "phone", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" }, { "name": "_tag", "value": "", "type": "query", "description": "Tags applied to this resource" }, { "name": "_has", "value": "", "type": "query", "description": "Return resources linked to by the given target" }, { "name": "address-use", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): 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
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" }, { "name": "_source", "value": "", "type": "query", "description": "Identifies where the resource comes from" }, { "name": "_id", "value": "", "type": "query", "description": "Logical id of this artifact" }, { "name": "_text", "value": "", "type": "query", "description": "Search on the narrative of the resource" }, { "name": "_content", "value": "", "type": "query", "description": "Search on the entire content of the resource" }, { "name": "family", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name" } ] }, "docs": "This is a search type" }, { "info": { "name": "create-type: Create a new Practitioner instance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/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": "search-type: Search for Practitioner instances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Practitioner/_search", "params": [ { "name": "address-state", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address" }, { "name": "gender", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person" }, { "name": "_lastUpdated", "value": "", "type": "query", "description": "When the resource version last changed" }, { "name": "address-country", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address" }, { "name": "phonetic", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm" }, { "name": "telecom", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact" }, { "name": "address-city", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): 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": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact" }, { "name": "given", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name" }, { "name": "identifier", "value": "", "type": "query", "description": "A practitioner's Identifier
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" }, { "name": "address", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): 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\r\n* [Person](person.html): 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\r\n* [Practitioner](practitioner.html): 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\r\n* [RelatedPerson](relatedperson.html): 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": "_security", "value": "", "type": "query", "description": "Security Labels applied to this resource" }, { "name": "active", "value": "", "type": "query", "description": "Whether the practitioner record is active" }, { "name": "address-postalcode", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address" }, { "name": "_filter", "value": "", "type": "query", "description": "Search the contents of the resource's data using a filter" }, { "name": "_profile", "value": "", "type": "query", "description": "Profiles this resource claims to conform to" }, { "name": "phone", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact" }, { "name": "_tag", "value": "", "type": "query", "description": "Tags applied to this resource" }, { "name": "_has", "value": "", "type": "query", "description": "Return resources linked to by the given target" }, { "name": "address-use", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): 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
\nNOTE: This US Core SearchParameter definition extends the usage context of\ncapabilitystatement-expectation\n extension to formally express implementer expectations for these elements:
\n - multipleAnd
\n - multipleOr
\n - modifier
\n - comparator
\n - chain
" }, { "name": "_source", "value": "", "type": "query", "description": "Identifies where the resource comes from" }, { "name": "_id", "value": "", "type": "query", "description": "Logical id of this artifact" }, { "name": "_text", "value": "", "type": "query", "description": "Search on the narrative of the resource" }, { "name": "_content", "value": "", "type": "query", "description": "Search on the entire content of the resource" }, { "name": "family", "value": "", "type": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name" } ] }, "docs": "This is a search type" }, { "info": { "name": "GET /Practitioner/$validate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Practitioner/$validate", "params": [ { "name": "mode", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /Practitioner/$validate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Practitioner/$validate", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /Practitioner/{id}/$validate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Practitioner/:id/$validate", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" }, { "name": "mode", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /Practitioner/{id}/$validate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Practitioner/:id/$validate", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Practitioner/{id}/$meta-delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/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": "{{baseUrl}}/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": "{{baseUrl}}/Practitioner/$meta" }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "POST /Practitioner/$meta", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Practitioner/$meta", "body": { "type": "json", "data": "{}" } }, "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": "{{baseUrl}}/Practitioner/:id/$meta", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ] }, "docs": "Request a list of tags, profiles, and security labels for a specfic resource instance" }, { "info": { "name": "POST /Practitioner/{id}/$meta", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Practitioner/:id/$meta", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } }, "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": "{{baseUrl}}/Practitioner/$expunge", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "POST /Practitioner/{id}/$expunge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Practitioner/:id/$expunge", "params": [ { "name": "id", "value": "123", "type": "path", "description": "The resource ID" } ], "body": { "type": "json", "data": "{}" } } } ] } ], "bundled": true }