{
"opencollection": "1.0.0",
"info": {
"name": "Untitled CodeSystem PractitionerRole API",
"version": "unspecified"
},
"items": [
{
"info": {
"name": "PractitionerRole",
"type": "folder"
},
"items": [
{
"info": {
"name": "read-instance: Read PractitionerRole instance",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/:id",
"params": [
{
"name": "id",
"value": "123",
"type": "path",
"description": "The resource ID"
}
]
},
"docs": "read-instance: Read PractitionerRole instance"
},
{
"info": {
"name": "update-instance: Update an existing PractitionerRole instance, or create using a client-assigned ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/PractitionerRole/:id",
"params": [
{
"name": "id",
"value": "123",
"type": "path",
"description": "The resource ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "update-instance: Update an existing PractitionerRole instance, or create using a client-assigned ID"
},
{
"info": {
"name": "instance-patch: Patch a resource instance of type PractitionerRole by ID",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/PractitionerRole/: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 PractitionerRole by ID"
},
{
"info": {
"name": "instance-delete: Perform a logical delete on a resource instance",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/PractitionerRole/: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 PractitionerRole instance with specific version",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/: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 PractitionerRole instance with specific version"
},
{
"info": {
"name": "search-type: Search for PractitionerRole instances",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The period during which the practitioner is authorized to perform in these role(s)"
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "A practitioner's Identifier"
},
{
"name": "specialty",
"value": "",
"type": "query",
"description": "The practitioner has this specialty at an organization
\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": "role",
"value": "",
"type": "query",
"description": "The practitioner can perform this role at for the organization"
},
{
"name": "practitioner",
"value": "",
"type": "query",
"description": "Practitioner that is able to provide the defined services for the organization
\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": "_lastUpdated",
"value": "",
"type": "query",
"description": "When the resource version last changed"
},
{
"name": "_security",
"value": "",
"type": "query",
"description": "Security Labels applied to this resource"
},
{
"name": "active",
"value": "",
"type": "query",
"description": "Whether this practitioner role record is in active use"
},
{
"name": "_filter",
"value": "",
"type": "query",
"description": "Search the contents of the resource's data using a filter"
},
{
"name": "endpoint",
"value": "",
"type": "query",
"description": "Technical endpoints providing access to services operated for the practitioner with this role"
},
{
"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": "service",
"value": "",
"type": "query",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
},
{
"name": "_tag",
"value": "",
"type": "query",
"description": "Tags applied to this resource"
},
{
"name": "organization",
"value": "",
"type": "query",
"description": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "_has",
"value": "",
"type": "query",
"description": "Return resources linked to by the given target"
},
{
"name": "_source",
"value": "",
"type": "query",
"description": "Identifies where the resource comes from"
},
{
"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": "location",
"value": "",
"type": "query",
"description": "One of the locations at which this practitioner provides care"
},
{
"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": "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"
}
]
},
"docs": "This is a search type"
},
{
"info": {
"name": "create-type: Create a new PractitionerRole instance",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "create-type: Create a new PractitionerRole instance"
},
{
"info": {
"name": "type-history: Fetch the resource change history for all resources of type PractitionerRole",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/_history"
},
"docs": "type-history: Fetch the resource change history for all resources of type PractitionerRole"
},
{
"info": {
"name": "instance-history: Fetch the resource change history for all resources of type PractitionerRole",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/: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 PractitionerRole"
},
{
"info": {
"name": "search-type: Search for PractitionerRole instances",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/_search",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The period during which the practitioner is authorized to perform in these role(s)"
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "A practitioner's Identifier"
},
{
"name": "specialty",
"value": "",
"type": "query",
"description": "The practitioner has this specialty at an organization
\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": "role",
"value": "",
"type": "query",
"description": "The practitioner can perform this role at for the organization"
},
{
"name": "practitioner",
"value": "",
"type": "query",
"description": "Practitioner that is able to provide the defined services for the organization
\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": "_lastUpdated",
"value": "",
"type": "query",
"description": "When the resource version last changed"
},
{
"name": "_security",
"value": "",
"type": "query",
"description": "Security Labels applied to this resource"
},
{
"name": "active",
"value": "",
"type": "query",
"description": "Whether this practitioner role record is in active use"
},
{
"name": "_filter",
"value": "",
"type": "query",
"description": "Search the contents of the resource's data using a filter"
},
{
"name": "endpoint",
"value": "",
"type": "query",
"description": "Technical endpoints providing access to services operated for the practitioner with this role"
},
{
"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": "service",
"value": "",
"type": "query",
"description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
},
{
"name": "_tag",
"value": "",
"type": "query",
"description": "Tags applied to this resource"
},
{
"name": "organization",
"value": "",
"type": "query",
"description": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "_has",
"value": "",
"type": "query",
"description": "Return resources linked to by the given target"
},
{
"name": "_source",
"value": "",
"type": "query",
"description": "Identifies where the resource comes from"
},
{
"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": "location",
"value": "",
"type": "query",
"description": "One of the locations at which this practitioner provides care"
},
{
"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": "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"
}
]
},
"docs": "This is a search type"
},
{
"info": {
"name": "GET /PractitionerRole/$validate",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/$validate",
"params": [
{
"name": "mode",
"value": "",
"type": "query"
}
]
}
},
{
"info": {
"name": "POST /PractitionerRole/$validate",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/$validate",
"body": {
"type": "json",
"data": "{}"
}
}
},
{
"info": {
"name": "GET /PractitionerRole/{id}/$validate",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/:id/$validate",
"params": [
{
"name": "id",
"value": "123",
"type": "path",
"description": "The resource ID"
},
{
"name": "mode",
"value": "",
"type": "query"
}
]
}
},
{
"info": {
"name": "POST /PractitionerRole/{id}/$validate",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/:id/$validate",
"params": [
{
"name": "id",
"value": "123",
"type": "path",
"description": "The resource ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
}
},
{
"info": {
"name": "POST /PractitionerRole/{id}/$meta-delete",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/: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 /PractitionerRole/{id}/$meta-add",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/: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 /PractitionerRole/$meta",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/$meta"
},
"docs": "Request a list of tags, profiles, and security labels for a specfic resource instance"
},
{
"info": {
"name": "POST /PractitionerRole/$meta",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/$meta",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Request a list of tags, profiles, and security labels for a specfic resource instance"
},
{
"info": {
"name": "GET /PractitionerRole/{id}/$meta",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/PractitionerRole/: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 /PractitionerRole/{id}/$meta",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/: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 /PractitionerRole/$expunge",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/$expunge",
"body": {
"type": "json",
"data": "{}"
}
}
},
{
"info": {
"name": "POST /PractitionerRole/{id}/$expunge",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/PractitionerRole/:id/$expunge",
"params": [
{
"name": "id",
"value": "123",
"type": "path",
"description": "The resource ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
}
}
]
}
],
"bundled": true
}