{ "openapi": "3.0.3", "info": { "title": "FALCON FHIR R4 Server API", "description": "FHIR R4 API for healthcare resource management. This API provides comprehensive FHIR-compliant endpoints for managing healthcare data including patients, observations, medications, encounters, and more.\n\n**Base URL**: https://fhir.imperiumsoft.biz:8443/fhir\n\n**FHIR Version**: 4.0.1 (R4)\n\n**Server Software**: FALCON FHIR Server 8.2.0", "version": "8.2.0", "termsOfService": "https://hapifhir.io/", "contact": { "name": "FHIR API Support", "url": "https://fhir.imperiumsoft.biz:8443/fhir", "email": "support@imperiumsoft.biz" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" } }, "externalDocs": { "description": "FHIR R4 Specification", "url": "https://hl7.org/fhir/R4/" }, "servers": [ { "url": "https://fhir.imperiumsoft.biz:8443/fhir", "description": "Production FHIR Server" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/metadata": { "get": { "summary": "Get Server Capability Statement", "description": "Returns the server's capability statement describing supported resources, operations, and search parameters.", "operationId": "getCapabilityStatement", "tags": ["System"], "responses": { "200": { "description": "Server capability statement", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CapabilityStatement" } } } } } } }, "/Patient/{id}": { "get": { "tags": [ "Patient" ], "summary": "read-instance: Read Patient instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "put": { "tags": [ "Patient" ], "summary": "update-instance: Update an existing Patient instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" }, "example": "{\n \"resourceType\": \"Patient\",\n \"text\": {\n \"status\": \"generated\",\n \"div\": \"
\"\n }\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" }, "example": "\n \n \n
\n \n \n
\n
\n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "delete": { "tags": [ "Patient" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "patch": { "tags": [ "Patient" ], "summary": "instance-patch: Patch a resource instance of type Patient by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/_history/{version_id}": { "get": { "tags": [ "Patient" ], "summary": "vread-instance: Read Patient instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient": { "get": { "tags": [ "Patient" ], "summary": "search-type: Search for Patient instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "deceased", "in": "query", "description": "This patient has been marked as deceased, or as a death date entered", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "link", "in": "query", "description": "All patients linked to the given patient", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code (irrespective of use value)", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "death-date", "in": "query", "description": "The date of death has been provided and satisfies this search value", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "phonetic", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "given", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A patient identifier", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "general-practitioner", "in": "query", "description": "Patient's nominated general practitioner, not the organization that manages the record", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether the patient record is active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The organization that is the custodian of the patient record", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "family", "in": "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "create-type: Create a new Patient instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" }, "example": "{\n \"resourceType\": \"Patient\",\n \"text\": {\n \"status\": \"generated\",\n \"div\": \"
\"\n }\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" }, "example": "\n \n \n
\n \n \n
\n
\n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/_history": { "get": { "tags": [ "Patient" ], "summary": "type-history: Fetch the resource change history for all resources of type Patient", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/_history": { "get": { "tags": [ "Patient" ], "summary": "instance-history: Fetch the resource change history for all resources of type Patient", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/_search": { "get": { "tags": [ "Patient" ], "summary": "search-type: Search for Patient instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "deceased", "in": "query", "description": "This patient has been marked as deceased, or as a death date entered", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "link", "in": "query", "description": "All patients linked to the given patient", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code (irrespective of use value)", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "death-date", "in": "query", "description": "The date of death has been provided and satisfies this search value", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "phonetic", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "given", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A patient identifier", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "general-practitioner", "in": "query", "description": "Patient's nominated general practitioner, not the organization that manages the record", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether the patient record is active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The organization that is the custodian of the patient record", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "family", "in": "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/$export": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/$export", "parameters": [ { "name": "_outputFormat", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_typeFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_typePostFetchFilterUrl", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_exportId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_mdm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/$export", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_outputFormat\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_since\"\n }, {\n \"name\": \"_typeFilter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_typePostFetchFilterUrl\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_exportId\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n }, {\n \"name\": \"patient\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$export": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/{id}/$export", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "_outputFormat", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_typeFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_typePostFetchFilterUrl", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_exportId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "_mdm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$export", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_outputFormat\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_since\"\n }, {\n \"name\": \"_typeFilter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_typePostFetchFilterUrl\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_exportId\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n }, {\n \"name\": \"patient\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/$summary": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/$summary", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"profile\",\n \"valueUri\": \"example\"\n }, {\n \"name\": \"identifier\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$summary": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$summary", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"profile\",\n \"valueUri\": \"example\"\n }, {\n \"name\": \"identifier\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/$validate": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Patient\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$validate": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Patient\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$meta-delete": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$meta-add": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/$meta": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$meta": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/$expunge": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$expunge": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/$everything": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/$everything", "parameters": [ { "name": "_count", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages.", "required": false, "schema": { "type": "string" } }, { "name": "_offset", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_type", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Filter the resources to return based on the patient ids provided.", "required": false, "schema": { "type": "string" } }, { "name": "_mdm", "in": "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)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/$everything", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_count\"\n }, {\n \"name\": \"_offset\"\n }, {\n \"name\": \"_lastUpdated\"\n }, {\n \"name\": \"_content\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_text\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_filter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_id\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$everything": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/{id}/$everything", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "_count", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages.", "required": false, "schema": { "type": "string" } }, { "name": "_offset", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_type", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Filter the resources to return based on the patient ids provided.", "required": false, "schema": { "type": "string" } }, { "name": "_mdm", "in": "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)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$everything", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_count\"\n }, {\n \"name\": \"_offset\"\n }, {\n \"name\": \"_lastUpdated\"\n }, {\n \"name\": \"_content\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_text\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_filter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_id\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$diff": { "get": { "tags": [ "Patient" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$reindex-dryrun": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$reindex": { "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Patient/{id}/$graphql": { "get": { "tags": [ "Patient" ], "summary": "GET: /Patient/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } }, "post": { "tags": [ "Patient" ], "summary": "POST: /Patient/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Patient" } } } } } } }, "/Observation/{id}": { "get": { "tags": [ "Observation" ], "summary": "read-instance: Read Observation instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "put": { "tags": [ "Observation" ], "summary": "update-instance: Update an existing Observation instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" }, "example": "{\n \"resourceType\": \"Observation\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "delete": { "tags": [ "Observation" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "patch": { "tags": [ "Observation" ], "summary": "instance-patch: Patch a resource instance of type Observation by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/_history/{version_id}": { "get": { "tags": [ "Observation" ], "summary": "vread-instance: Read Observation instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation": { "get": { "tags": [ "Observation" ], "summary": "search-type: Search for Observation instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject that the observation is about", "required": false, "schema": { "type": "string" } }, { "name": "value-concept", "in": "query", "description": "The value of the observation, if the value is a CodeableConcept", "required": false, "schema": { "type": "string" } }, { "name": "value-date", "in": "query", "description": "The value of the observation, if the value is a date or period of time", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "derived-from", "in": "query", "description": "Related measurements the observation is made from", "required": false, "schema": { "type": "string" } }, { "name": "focus", "in": "query", "description": "The focus of an observation when the focus is not the patient of record.", "required": false, "schema": { "type": "string" } }, { "name": "has-member", "in": "query", "description": "Related resource that belongs to the Observation group", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "component-code-value-quantity", "in": "query", "description": "Component code and component quantity value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "code-value-date", "in": "query", "description": "Code and date/time value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "code-value-quantity", "in": "query", "description": "Code and quantity value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "combo-code-value-concept", "in": "query", "description": "Code and coded value parameter pair, including in components", "required": false, "schema": { "type": "string" } }, { "name": "value-string", "in": "query", "description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "description": "The method used for the observation", "required": false, "schema": { "type": "string" } }, { "name": "value-quantity", "in": "query", "description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "combo-value-quantity", "in": "query", "description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "code-value-concept", "in": "query", "description": "Code and coded value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "The Device that generated the observation data.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the observation", "required": false, "schema": { "type": "string" } }, { "name": "combo-data-absent-reason", "in": "query", "description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "component-data-absent-reason", "in": "query", "description": "The reason why the expected value in the element Observation.component.value[x] is missing.", "required": false, "schema": { "type": "string" } }, { "name": "combo-code-value-quantity", "in": "query", "description": "Code and quantity value parameter pair, including in components", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "part-of", "in": "query", "description": "Part of referenced event", "required": false, "schema": { "type": "string" } }, { "name": "code-value-string", "in": "query", "description": "Code and string value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Reference to the service request.", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "specimen", "in": "query", "description": "Specimen used for this observation", "required": false, "schema": { "type": "string" } }, { "name": "component-code", "in": "query", "description": "The component code of the observation type", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Who performed the observation", "required": false, "schema": { "type": "string" } }, { "name": "combo-code", "in": "query", "description": "The code of the observation type or component type", "required": false, "schema": { "type": "string" } }, { "name": "component-value-quantity", "in": "query", "description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "data-absent-reason", "in": "query", "description": "The reason why the expected value in the element Observation.value[x] is missing.", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "component-code-value-concept", "in": "query", "description": "Component code and component coded value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "component-value-concept", "in": "query", "description": "The value of the component observation, if the value is a CodeableConcept", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "The classification of the type of observation", "required": false, "schema": { "type": "string" } }, { "name": "combo-value-concept", "in": "query", "description": "The value or component value of the observation, if the value is a CodeableConcept", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "create-type: Create a new Observation instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" }, "example": "{\n \"resourceType\": \"Observation\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/_history": { "get": { "tags": [ "Observation" ], "summary": "type-history: Fetch the resource change history for all resources of type Observation", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/_history": { "get": { "tags": [ "Observation" ], "summary": "instance-history: Fetch the resource change history for all resources of type Observation", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/_search": { "get": { "tags": [ "Observation" ], "summary": "search-type: Search for Observation instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject that the observation is about", "required": false, "schema": { "type": "string" } }, { "name": "value-concept", "in": "query", "description": "The value of the observation, if the value is a CodeableConcept", "required": false, "schema": { "type": "string" } }, { "name": "value-date", "in": "query", "description": "The value of the observation, if the value is a date or period of time", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "derived-from", "in": "query", "description": "Related measurements the observation is made from", "required": false, "schema": { "type": "string" } }, { "name": "focus", "in": "query", "description": "The focus of an observation when the focus is not the patient of record.", "required": false, "schema": { "type": "string" } }, { "name": "has-member", "in": "query", "description": "Related resource that belongs to the Observation group", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "component-code-value-quantity", "in": "query", "description": "Component code and component quantity value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "code-value-date", "in": "query", "description": "Code and date/time value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "code-value-quantity", "in": "query", "description": "Code and quantity value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "combo-code-value-concept", "in": "query", "description": "Code and coded value parameter pair, including in components", "required": false, "schema": { "type": "string" } }, { "name": "value-string", "in": "query", "description": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "method", "in": "query", "description": "The method used for the observation", "required": false, "schema": { "type": "string" } }, { "name": "value-quantity", "in": "query", "description": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "combo-value-quantity", "in": "query", "description": "The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "code-value-concept", "in": "query", "description": "Code and coded value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "The Device that generated the observation data.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the observation", "required": false, "schema": { "type": "string" } }, { "name": "combo-data-absent-reason", "in": "query", "description": "The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "component-data-absent-reason", "in": "query", "description": "The reason why the expected value in the element Observation.component.value[x] is missing.", "required": false, "schema": { "type": "string" } }, { "name": "combo-code-value-quantity", "in": "query", "description": "Code and quantity value parameter pair, including in components", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "part-of", "in": "query", "description": "Part of referenced event", "required": false, "schema": { "type": "string" } }, { "name": "code-value-string", "in": "query", "description": "Code and string value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Reference to the service request.", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "specimen", "in": "query", "description": "Specimen used for this observation", "required": false, "schema": { "type": "string" } }, { "name": "component-code", "in": "query", "description": "The component code of the observation type", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Who performed the observation", "required": false, "schema": { "type": "string" } }, { "name": "combo-code", "in": "query", "description": "The code of the observation type or component type", "required": false, "schema": { "type": "string" } }, { "name": "component-value-quantity", "in": "query", "description": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "data-absent-reason", "in": "query", "description": "The reason why the expected value in the element Observation.value[x] is missing.", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "component-code-value-concept", "in": "query", "description": "Component code and component coded value parameter pair", "required": false, "schema": { "type": "string" } }, { "name": "component-value-concept", "in": "query", "description": "The value of the component observation, if the value is a CodeableConcept", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "The classification of the type of observation", "required": false, "schema": { "type": "string" } }, { "name": "combo-value-concept", "in": "query", "description": "The value or component value of the observation, if the value is a CodeableConcept", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/$validate": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Observation\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$validate": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Observation\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$meta-delete": { "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$meta-add": { "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/$meta": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$meta": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/$expunge": { "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$expunge": { "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/$lastn": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/$lastn", "parameters": [ { "name": "_count", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages.", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "The classification of the type of observation", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "The code of the observation type", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "The effective date of the observation", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "patient", "in": "query", "description": "The subject that the observation is about (if patient)", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject that the observation is about", "required": false, "schema": { "type": "string" } }, { "name": "max", "in": "query", "description": "The maximum number of observations to return for each observation code", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/$lastn", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_count\"\n }, {\n \"name\": \"category\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"code\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"date\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"patient\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"subject\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"max\",\n \"valueInteger\": 0\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$diff": { "get": { "tags": [ "Observation" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$reindex-dryrun": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$reindex": { "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/Observation/{id}/$graphql": { "get": { "tags": [ "Observation" ], "summary": "GET: /Observation/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } }, "post": { "tags": [ "Observation" ], "summary": "POST: /Observation/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Observation" } } } } } } }, "/MedicationRequest/{id}": { "get": { "tags": [ "MedicationRequest" ], "summary": "read-instance: Read MedicationRequest instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "put": { "tags": [ "MedicationRequest" ], "summary": "update-instance: Update an existing MedicationRequest instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" }, "example": "{\n \"resourceType\": \"MedicationRequest\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "delete": { "tags": [ "MedicationRequest" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "patch": { "tags": [ "MedicationRequest" ], "summary": "instance-patch: Patch a resource instance of type MedicationRequest by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/_history/{version_id}": { "get": { "tags": [ "MedicationRequest" ], "summary": "vread-instance: Read MedicationRequest instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest": { "get": { "tags": [ "MedicationRequest" ], "summary": "search-type: Search for MedicationRequest instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "authoredon", "in": "query", "description": "Return prescriptions written on this date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "subject", "in": "query", "description": "The identity of a patient to list orders for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "intended-performer", "in": "query", "description": "Returns the intended performer of the administration of the medication request", "required": false, "schema": { "type": "string" } }, { "name": "intended-performertype", "in": "query", "description": "Returns requests for a specific type of performer", "required": false, "schema": { "type": "string" } }, { "name": "requester", "in": "query", "description": "Returns prescriptions prescribed by this prescriber", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "intended-dispenser", "in": "query", "description": "Returns prescriptions intended to be dispensed by this Organization", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "medication", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "Returns prescriptions with different priorities", "required": false, "schema": { "type": "string" } }, { "name": "intent", "in": "query", "description": "Returns prescriptions with different intents", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Returns prescriptions with different categories", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "create-type: Create a new MedicationRequest instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" }, "example": "{\n \"resourceType\": \"MedicationRequest\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/_history": { "get": { "tags": [ "MedicationRequest" ], "summary": "type-history: Fetch the resource change history for all resources of type MedicationRequest", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/_history": { "get": { "tags": [ "MedicationRequest" ], "summary": "instance-history: Fetch the resource change history for all resources of type MedicationRequest", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/_search": { "get": { "tags": [ "MedicationRequest" ], "summary": "search-type: Search for MedicationRequest instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Returns medication request to be administered on a specific date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "authoredon", "in": "query", "description": "Return prescriptions written on this date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "subject", "in": "query", "description": "The identity of a patient to list orders for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "intended-performer", "in": "query", "description": "Returns the intended performer of the administration of the medication request", "required": false, "schema": { "type": "string" } }, { "name": "intended-performertype", "in": "query", "description": "Returns requests for a specific type of performer", "required": false, "schema": { "type": "string" } }, { "name": "requester", "in": "query", "description": "Returns prescriptions prescribed by this prescriber", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "intended-dispenser", "in": "query", "description": "Returns prescriptions intended to be dispensed by this Organization", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "medication", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "Returns prescriptions with different priorities", "required": false, "schema": { "type": "string" } }, { "name": "intent", "in": "query", "description": "Returns prescriptions with different intents", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Returns prescriptions with different categories", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/$validate": { "get": { "tags": [ "MedicationRequest" ], "summary": "GET: /MedicationRequest/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"MedicationRequest\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$validate": { "get": { "tags": [ "MedicationRequest" ], "summary": "GET: /MedicationRequest/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"MedicationRequest\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$meta-delete": { "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$meta-add": { "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/$meta": { "get": { "tags": [ "MedicationRequest" ], "summary": "GET: /MedicationRequest/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$meta": { "get": { "tags": [ "MedicationRequest" ], "summary": "GET: /MedicationRequest/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/$expunge": { "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$expunge": { "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$diff": { "get": { "tags": [ "MedicationRequest" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$reindex-dryrun": { "get": { "tags": [ "MedicationRequest" ], "summary": "GET: /MedicationRequest/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$reindex": { "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/MedicationRequest/{id}/$graphql": { "get": { "tags": [ "MedicationRequest" ], "summary": "GET: /MedicationRequest/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } }, "post": { "tags": [ "MedicationRequest" ], "summary": "POST: /MedicationRequest/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationRequest" } } } } } } }, "/Encounter/{id}": { "get": { "tags": [ "Encounter" ], "summary": "read-instance: Read Encounter instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "put": { "tags": [ "Encounter" ], "summary": "update-instance: Update an existing Encounter instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" }, "example": "{\n \"resourceType\": \"Encounter\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "delete": { "tags": [ "Encounter" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "patch": { "tags": [ "Encounter" ], "summary": "instance-patch: Patch a resource instance of type Encounter by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/_history/{version_id}": { "get": { "tags": [ "Encounter" ], "summary": "vread-instance: Read Encounter instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter": { "get": { "tags": [ "Encounter" ], "summary": "search-type: Search for Encounter instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "participant-type", "in": "query", "description": "Role of participant in encounter", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The patient or group present at the encounter", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "appointment", "in": "query", "description": "The appointment that scheduled this encounter", "required": false, "schema": { "type": "string" } }, { "name": "part-of", "in": "query", "description": "Another Encounter this encounter is part of", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Persons involved in the encounter other than the patient", "required": false, "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Coded reason the encounter takes place", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "The ServiceRequest that initiated this encounter", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "location-period", "in": "query", "description": "Time period during which the patient was present at the location", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "special-arrangement", "in": "query", "description": "Wheelchair, translator, stretcher, etc.", "required": false, "schema": { "type": "string" } }, { "name": "class", "in": "query", "description": "Classification of patient encounter", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "description": "Persons involved in the encounter other than the patient", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "episode-of-care", "in": "query", "description": "Episode(s) of care that this encounter should be recorded against", "required": false, "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "Length of encounter in days", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "diagnosis", "in": "query", "description": "The diagnosis or procedure relevant to the encounter", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "Reason the encounter takes place (reference)", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Location the encounter takes place", "required": false, "schema": { "type": "string" } }, { "name": "service-provider", "in": "query", "description": "The organization (facility) responsible for this encounter", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "account", "in": "query", "description": "The set of accounts that may be used for billing for this Encounter", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "create-type: Create a new Encounter instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" }, "example": "{\n \"resourceType\": \"Encounter\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/_history": { "get": { "tags": [ "Encounter" ], "summary": "type-history: Fetch the resource change history for all resources of type Encounter", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/_history": { "get": { "tags": [ "Encounter" ], "summary": "instance-history: Fetch the resource change history for all resources of type Encounter", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/_search": { "get": { "tags": [ "Encounter" ], "summary": "search-type: Search for Encounter instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "participant-type", "in": "query", "description": "Role of participant in encounter", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The patient or group present at the encounter", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "appointment", "in": "query", "description": "The appointment that scheduled this encounter", "required": false, "schema": { "type": "string" } }, { "name": "part-of", "in": "query", "description": "Another Encounter this encounter is part of", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Persons involved in the encounter other than the patient", "required": false, "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Coded reason the encounter takes place", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "The ServiceRequest that initiated this encounter", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "location-period", "in": "query", "description": "Time period during which the patient was present at the location", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "special-arrangement", "in": "query", "description": "Wheelchair, translator, stretcher, etc.", "required": false, "schema": { "type": "string" } }, { "name": "class", "in": "query", "description": "Classification of patient encounter", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "description": "Persons involved in the encounter other than the patient", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "episode-of-care", "in": "query", "description": "Episode(s) of care that this encounter should be recorded against", "required": false, "schema": { "type": "string" } }, { "name": "length", "in": "query", "description": "Length of encounter in days", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "diagnosis", "in": "query", "description": "The diagnosis or procedure relevant to the encounter", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "Reason the encounter takes place (reference)", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Location the encounter takes place", "required": false, "schema": { "type": "string" } }, { "name": "service-provider", "in": "query", "description": "The organization (facility) responsible for this encounter", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "account", "in": "query", "description": "The set of accounts that may be used for billing for this Encounter", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/$validate": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Encounter\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$validate": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Encounter\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$meta-delete": { "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$meta-add": { "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/$meta": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$meta": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/$expunge": { "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$expunge": { "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/$everything": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/$everything", "parameters": [ { "name": "_count", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages.", "required": false, "schema": { "type": "string" } }, { "name": "_offset", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_type", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Filter the resources to return based on the patient ids provided.", "required": false, "schema": { "type": "string" } }, { "name": "_mdm", "in": "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)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/$everything", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_count\"\n }, {\n \"name\": \"_offset\"\n }, {\n \"name\": \"_lastUpdated\"\n }, {\n \"name\": \"_content\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_text\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_filter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_id\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$everything": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/{id}/$everything", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "_count", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the size of those pages.", "required": false, "schema": { "type": "string" } }, { "name": "_offset", "in": "query", "description": "Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_type", "in": "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)", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Filter the resources to return based on the patient ids provided.", "required": false, "schema": { "type": "string" } }, { "name": "_mdm", "in": "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)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$everything", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_count\"\n }, {\n \"name\": \"_offset\"\n }, {\n \"name\": \"_lastUpdated\"\n }, {\n \"name\": \"_content\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_text\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_filter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_id\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$diff": { "get": { "tags": [ "Encounter" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$reindex-dryrun": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$reindex": { "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Encounter/{id}/$graphql": { "get": { "tags": [ "Encounter" ], "summary": "GET: /Encounter/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } }, "post": { "tags": [ "Encounter" ], "summary": "POST: /Encounter/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Encounter" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Encounter" } } } } } } }, "/Condition/{id}": { "get": { "tags": [ "Condition" ], "summary": "read-instance: Read Condition instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "put": { "tags": [ "Condition" ], "summary": "update-instance: Update an existing Condition instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" }, "example": "{\n \"resourceType\": \"Condition\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "delete": { "tags": [ "Condition" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "patch": { "tags": [ "Condition" ], "summary": "instance-patch: Patch a resource instance of type Condition by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/_history/{version_id}": { "get": { "tags": [ "Condition" ], "summary": "vread-instance: Read Condition instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition": { "get": { "tags": [ "Condition" ], "summary": "search-type: Search for Condition instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "onset-info", "in": "query", "description": "Onsets as a string", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "evidence", "in": "query", "description": "Manifestation/symptom", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who has the condition?", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "verification-status", "in": "query", "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", "required": false, "schema": { "type": "string" } }, { "name": "clinical-status", "in": "query", "description": "The clinical status of the condition", "required": false, "schema": { "type": "string" } }, { "name": "onset-date", "in": "query", "description": "Date related onsets (dateTime and Period)", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "abatement-date", "in": "query", "description": "Date-related abatements (dateTime and period)", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "abatement-age", "in": "query", "description": "Abatement as age or age range", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "evidence-detail", "in": "query", "description": "Supporting information found elsewhere", "required": false, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "The severity of the condition", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "recorded-date", "in": "query", "description": "Date record was first recorded", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "asserter", "in": "query", "description": "Person who asserts this condition", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "stage", "in": "query", "description": "Simple summary (disease specific)", "required": false, "schema": { "type": "string" } }, { "name": "abatement-string", "in": "query", "description": "Abatement as a string", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "onset-age", "in": "query", "description": "Onsets as age or age range", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "body-site", "in": "query", "description": "Anatomical location, if relevant", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "The category of the condition", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "create-type: Create a new Condition instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" }, "example": "{\n \"resourceType\": \"Condition\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/_history": { "get": { "tags": [ "Condition" ], "summary": "type-history: Fetch the resource change history for all resources of type Condition", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/_history": { "get": { "tags": [ "Condition" ], "summary": "instance-history: Fetch the resource change history for all resources of type Condition", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/_search": { "get": { "tags": [ "Condition" ], "summary": "search-type: Search for Condition instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "onset-info", "in": "query", "description": "Onsets as a string", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "evidence", "in": "query", "description": "Manifestation/symptom", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who has the condition?", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "verification-status", "in": "query", "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", "required": false, "schema": { "type": "string" } }, { "name": "clinical-status", "in": "query", "description": "The clinical status of the condition", "required": false, "schema": { "type": "string" } }, { "name": "onset-date", "in": "query", "description": "Date related onsets (dateTime and Period)", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "abatement-date", "in": "query", "description": "Date-related abatements (dateTime and period)", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "abatement-age", "in": "query", "description": "Abatement as age or age range", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "evidence-detail", "in": "query", "description": "Supporting information found elsewhere", "required": false, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "The severity of the condition", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "recorded-date", "in": "query", "description": "Date record was first recorded", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "asserter", "in": "query", "description": "Person who asserts this condition", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "stage", "in": "query", "description": "Simple summary (disease specific)", "required": false, "schema": { "type": "string" } }, { "name": "abatement-string", "in": "query", "description": "Abatement as a string", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "onset-age", "in": "query", "description": "Onsets as age or age range", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "body-site", "in": "query", "description": "Anatomical location, if relevant", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "The category of the condition", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/$validate": { "get": { "tags": [ "Condition" ], "summary": "GET: /Condition/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Condition\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$validate": { "get": { "tags": [ "Condition" ], "summary": "GET: /Condition/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Condition\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$meta-delete": { "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$meta-add": { "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/$meta": { "get": { "tags": [ "Condition" ], "summary": "GET: /Condition/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$meta": { "get": { "tags": [ "Condition" ], "summary": "GET: /Condition/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/$expunge": { "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$expunge": { "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$diff": { "get": { "tags": [ "Condition" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$reindex-dryrun": { "get": { "tags": [ "Condition" ], "summary": "GET: /Condition/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$reindex": { "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Condition/{id}/$graphql": { "get": { "tags": [ "Condition" ], "summary": "GET: /Condition/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } }, "post": { "tags": [ "Condition" ], "summary": "POST: /Condition/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/DiagnosticReport/{id}": { "get": { "tags": [ "DiagnosticReport" ], "summary": "read-instance: Read DiagnosticReport instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "put": { "tags": [ "DiagnosticReport" ], "summary": "update-instance: Update an existing DiagnosticReport instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" }, "example": "{\n \"resourceType\": \"DiagnosticReport\",\n \"text\": {\n \"status\": \"generated\",\n \"div\": \"
\"\n }\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" }, "example": "\n \n \n
\n
\n \n \n
\n
\n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "delete": { "tags": [ "DiagnosticReport" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "patch": { "tags": [ "DiagnosticReport" ], "summary": "instance-patch: Patch a resource instance of type DiagnosticReport by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/_history/{version_id}": { "get": { "tags": [ "DiagnosticReport" ], "summary": "vread-instance: Read DiagnosticReport instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport": { "get": { "tags": [ "DiagnosticReport" ], "summary": "search-type: Search for DiagnosticReport instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject of the report", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "media", "in": "query", "description": "A reference to the image source.", "required": false, "schema": { "type": "string" } }, { "name": "conclusion", "in": "query", "description": "A coded conclusion (interpretation/impression) on the report", "required": false, "schema": { "type": "string" } }, { "name": "result", "in": "query", "description": "Link to an atomic result (observation resource)", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Reference to the service request.", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "specimen", "in": "query", "description": "The specimen details", "required": false, "schema": { "type": "string" } }, { "name": "issued", "in": "query", "description": "When the report was issued", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Who is responsible for the report", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Which diagnostic discipline/department created the report", "required": false, "schema": { "type": "string" } }, { "name": "results-interpreter", "in": "query", "description": "Who was the source of the report", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the report", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "create-type: Create a new DiagnosticReport instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" }, "example": "{\n \"resourceType\": \"DiagnosticReport\",\n \"text\": {\n \"status\": \"generated\",\n \"div\": \"
\"\n }\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" }, "example": "\n \n \n
\n
\n \n \n
\n
\n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/_history": { "get": { "tags": [ "DiagnosticReport" ], "summary": "type-history: Fetch the resource change history for all resources of type DiagnosticReport", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/_history": { "get": { "tags": [ "DiagnosticReport" ], "summary": "instance-history: Fetch the resource change history for all resources of type DiagnosticReport", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/_search": { "get": { "tags": [ "DiagnosticReport" ], "summary": "search-type: Search for DiagnosticReport instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject of the report", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "media", "in": "query", "description": "A reference to the image source.", "required": false, "schema": { "type": "string" } }, { "name": "conclusion", "in": "query", "description": "A coded conclusion (interpretation/impression) on the report", "required": false, "schema": { "type": "string" } }, { "name": "result", "in": "query", "description": "Link to an atomic result (observation resource)", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Reference to the service request.", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "specimen", "in": "query", "description": "The specimen details", "required": false, "schema": { "type": "string" } }, { "name": "issued", "in": "query", "description": "When the report was issued", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Who is responsible for the report", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Which diagnostic discipline/department created the report", "required": false, "schema": { "type": "string" } }, { "name": "results-interpreter", "in": "query", "description": "Who was the source of the report", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the report", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/$validate": { "get": { "tags": [ "DiagnosticReport" ], "summary": "GET: /DiagnosticReport/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"DiagnosticReport\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$validate": { "get": { "tags": [ "DiagnosticReport" ], "summary": "GET: /DiagnosticReport/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"DiagnosticReport\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$meta-delete": { "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$meta-add": { "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/$meta": { "get": { "tags": [ "DiagnosticReport" ], "summary": "GET: /DiagnosticReport/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$meta": { "get": { "tags": [ "DiagnosticReport" ], "summary": "GET: /DiagnosticReport/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/$expunge": { "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$expunge": { "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$diff": { "get": { "tags": [ "DiagnosticReport" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$reindex-dryrun": { "get": { "tags": [ "DiagnosticReport" ], "summary": "GET: /DiagnosticReport/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$reindex": { "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/DiagnosticReport/{id}/$graphql": { "get": { "tags": [ "DiagnosticReport" ], "summary": "GET: /DiagnosticReport/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } }, "post": { "tags": [ "DiagnosticReport" ], "summary": "POST: /DiagnosticReport/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticReport" } } } } } } }, "/Binary": { "get": { "summary": "Search Binary Resources", "description": "Search for Binary resources. Contains 423 binary records for document attachments and media.", "operationId": "searchBinary", "tags": ["Binary"], "parameters": [ { "name": "contenttype", "in": "query", "description": "MimeType of the binary content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Search results", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } } } } }, "/AllergyIntolerance/{id}": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "read-instance: Read AllergyIntolerance instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "put": { "tags": [ "AllergyIntolerance" ], "summary": "update-instance: Update an existing AllergyIntolerance instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" }, "example": "{\n \"resourceType\": \"AllergyIntolerance\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "delete": { "tags": [ "AllergyIntolerance" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "patch": { "tags": [ "AllergyIntolerance" ], "summary": "instance-patch: Patch a resource instance of type AllergyIntolerance by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/_history/{version_id}": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "vread-instance: Read AllergyIntolerance instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "search-type: Search for AllergyIntolerance instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "verification-status", "in": "query", "description": "unconfirmed | confirmed | refuted | entered-in-error", "required": false, "schema": { "type": "string" } }, { "name": "criticality", "in": "query", "description": "low | high | unable-to-assess", "required": false, "schema": { "type": "string" } }, { "name": "clinical-status", "in": "query", "description": "active | inactive | resolved", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "mild | moderate | severe (of event as a whole)", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "manifestation", "in": "query", "description": "Clinical symptoms/signs associated with the Event", "required": false, "schema": { "type": "string" } }, { "name": "recorder", "in": "query", "description": "Who recorded the sensitivity", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "onset", "in": "query", "description": "Date(/time) when manifestations showed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "asserter", "in": "query", "description": "Source of the information about the allergy", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "description": "How the subject was exposed to the substance", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "food | medication | environment | biologic", "required": false, "schema": { "type": "string" } }, { "name": "last-date", "in": "query", "description": "Date(/time) of last known occurrence of a reaction", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "create-type: Create a new AllergyIntolerance instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" }, "example": "{\n \"resourceType\": \"AllergyIntolerance\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/_history": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "type-history: Fetch the resource change history for all resources of type AllergyIntolerance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/_history": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "instance-history: Fetch the resource change history for all resources of type AllergyIntolerance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/_search": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "search-type: Search for AllergyIntolerance instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "verification-status", "in": "query", "description": "unconfirmed | confirmed | refuted | entered-in-error", "required": false, "schema": { "type": "string" } }, { "name": "criticality", "in": "query", "description": "low | high | unable-to-assess", "required": false, "schema": { "type": "string" } }, { "name": "clinical-status", "in": "query", "description": "active | inactive | resolved", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "mild | moderate | severe (of event as a whole)", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "manifestation", "in": "query", "description": "Clinical symptoms/signs associated with the Event", "required": false, "schema": { "type": "string" } }, { "name": "recorder", "in": "query", "description": "Who recorded the sensitivity", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "onset", "in": "query", "description": "Date(/time) when manifestations showed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "asserter", "in": "query", "description": "Source of the information about the allergy", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "description": "How the subject was exposed to the substance", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "food | medication | environment | biologic", "required": false, "schema": { "type": "string" } }, { "name": "last-date", "in": "query", "description": "Date(/time) of last known occurrence of a reaction", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/$validate": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "GET: /AllergyIntolerance/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"AllergyIntolerance\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$validate": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "GET: /AllergyIntolerance/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"AllergyIntolerance\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$meta-delete": { "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$meta-add": { "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/$meta": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "GET: /AllergyIntolerance/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$meta": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "GET: /AllergyIntolerance/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/$expunge": { "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$expunge": { "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$diff": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$reindex-dryrun": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "GET: /AllergyIntolerance/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$reindex": { "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/AllergyIntolerance/{id}/$graphql": { "get": { "tags": [ "AllergyIntolerance" ], "summary": "GET: /AllergyIntolerance/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } }, "post": { "tags": [ "AllergyIntolerance" ], "summary": "POST: /AllergyIntolerance/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/AllergyIntolerance" } } } } } } }, "/MedicationDispense/{id}": { "get": { "tags": [ "MedicationDispense" ], "summary": "read-instance: Read MedicationDispense instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "put": { "tags": [ "MedicationDispense" ], "summary": "update-instance: Update an existing MedicationDispense instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" }, "example": "{\n \"resourceType\": \"MedicationDispense\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "delete": { "tags": [ "MedicationDispense" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "patch": { "tags": [ "MedicationDispense" ], "summary": "instance-patch: Patch a resource instance of type MedicationDispense by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/_history/{version_id}": { "get": { "tags": [ "MedicationDispense" ], "summary": "vread-instance: Read MedicationDispense instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense": { "get": { "tags": [ "MedicationDispense" ], "summary": "search-type: Search for MedicationDispense instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The identity of a patient for whom to list dispenses", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "destination", "in": "query", "description": "Returns dispenses that should be sent to a specific destination", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Returns dispenses of a specific type", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Returns dispenses with a specific context (episode or episode of care)", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Returns dispenses performed by a specific individual", "required": false, "schema": { "type": "string" } }, { "name": "receiver", "in": "query", "description": "The identity of a receiver to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "medication", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference", "required": false, "schema": { "type": "string" } }, { "name": "responsibleparty", "in": "query", "description": "Returns dispenses with the specified responsible party", "required": false, "schema": { "type": "string" } }, { "name": "whenhandedover", "in": "query", "description": "Returns dispenses handed over on this date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "whenprepared", "in": "query", "description": "Returns dispenses prepared on this date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "prescription", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "create-type: Create a new MedicationDispense instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" }, "example": "{\n \"resourceType\": \"MedicationDispense\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/_history": { "get": { "tags": [ "MedicationDispense" ], "summary": "type-history: Fetch the resource change history for all resources of type MedicationDispense", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/_history": { "get": { "tags": [ "MedicationDispense" ], "summary": "instance-history: Fetch the resource change history for all resources of type MedicationDispense", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/_search": { "get": { "tags": [ "MedicationDispense" ], "summary": "search-type: Search for MedicationDispense instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The identity of a patient for whom to list dispenses", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "destination", "in": "query", "description": "Returns dispenses that should be sent to a specific destination", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Returns dispenses of a specific type", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Returns dispenses with a specific context (episode or episode of care)", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Returns dispenses performed by a specific individual", "required": false, "schema": { "type": "string" } }, { "name": "receiver", "in": "query", "description": "The identity of a receiver to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "medication", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication resource\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication reference", "required": false, "schema": { "type": "string" } }, { "name": "responsibleparty", "in": "query", "description": "Returns dispenses with the specified responsible party", "required": false, "schema": { "type": "string" } }, { "name": "whenhandedover", "in": "query", "description": "Returns dispenses handed over on this date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "whenprepared", "in": "query", "description": "Returns dispenses prepared on this date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "prescription", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationDispense](medicationdispense.html): The identity of a prescription to list dispenses from", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified)\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status\r\n* [MedicationRequest](medicationrequest.html): Status of the prescription\r\n* [MedicationStatement](medicationstatement.html): Return statements that match the given status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/$validate": { "get": { "tags": [ "MedicationDispense" ], "summary": "GET: /MedicationDispense/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"MedicationDispense\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$validate": { "get": { "tags": [ "MedicationDispense" ], "summary": "GET: /MedicationDispense/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"MedicationDispense\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$meta-delete": { "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$meta-add": { "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/$meta": { "get": { "tags": [ "MedicationDispense" ], "summary": "GET: /MedicationDispense/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$meta": { "get": { "tags": [ "MedicationDispense" ], "summary": "GET: /MedicationDispense/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/$expunge": { "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$expunge": { "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$diff": { "get": { "tags": [ "MedicationDispense" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$reindex-dryrun": { "get": { "tags": [ "MedicationDispense" ], "summary": "GET: /MedicationDispense/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$reindex": { "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/MedicationDispense/{id}/$graphql": { "get": { "tags": [ "MedicationDispense" ], "summary": "GET: /MedicationDispense/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } }, "post": { "tags": [ "MedicationDispense" ], "summary": "POST: /MedicationDispense/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/MedicationDispense" } } } } } } }, "/DocumentReference/{id}": { "get": { "tags": [ "DocumentReference" ], "summary": "read-instance: Read DocumentReference instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "put": { "tags": [ "DocumentReference" ], "summary": "update-instance: Update an existing DocumentReference instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" }, "example": "{\n \"resourceType\": \"DocumentReference\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "delete": { "tags": [ "DocumentReference" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "patch": { "tags": [ "DocumentReference" ], "summary": "instance-patch: Patch a resource instance of type DocumentReference by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/_history/{version_id}": { "get": { "tags": [ "DocumentReference" ], "summary": "vread-instance: Read DocumentReference instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference": { "get": { "tags": [ "DocumentReference" ], "summary": "search-type: Search for DocumentReference instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "When this document reference was created", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who/what is the subject of the document", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "description", "in": "query", "description": "Human-readable description", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Human language of the content (BCP-47)", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management", "required": false, "schema": { "type": "string" } }, { "name": "relation", "in": "query", "description": "replaces | transforms | signs | appends", "required": false, "schema": { "type": "string" } }, { "name": "setting", "in": "query", "description": "Additional details about where the content was created (e.g. clinical specialty)", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "related", "in": "query", "description": "Related identifiers or resources", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Main clinical acts documented", "required": false, "schema": { "type": "string" } }, { "name": "relationship", "in": "query", "description": "Combination of relation and relatesTo", "required": false, "schema": { "type": "string" } }, { "name": "authenticator", "in": "query", "description": "Who/what authenticated the document", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Time of service that is being documented", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "custodian", "in": "query", "description": "Organization which maintains the document", "required": false, "schema": { "type": "string" } }, { "name": "author", "in": "query", "description": "Who and/or what authored the document", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Format/content rules for the document", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "contenttype", "in": "query", "description": "Mime type of the content, with charset etc.", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "security-label", "in": "query", "description": "Document security-tags", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Uri where the data can be found", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Categorization of document", "required": false, "schema": { "type": "string" } }, { "name": "relatesto", "in": "query", "description": "Target of the relationship", "required": false, "schema": { "type": "string" } }, { "name": "facility", "in": "query", "description": "Kind of facility where patient was seen", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "current | superseded | entered-in-error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "create-type: Create a new DocumentReference instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" }, "example": "{\n \"resourceType\": \"DocumentReference\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/_history": { "get": { "tags": [ "DocumentReference" ], "summary": "type-history: Fetch the resource change history for all resources of type DocumentReference", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/_history": { "get": { "tags": [ "DocumentReference" ], "summary": "instance-history: Fetch the resource change history for all resources of type DocumentReference", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/_search": { "get": { "tags": [ "DocumentReference" ], "summary": "search-type: Search for DocumentReference instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "When this document reference was created", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who/what is the subject of the document", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "description", "in": "query", "description": "Human-readable description", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Human language of the content (BCP-47)", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management", "required": false, "schema": { "type": "string" } }, { "name": "relation", "in": "query", "description": "replaces | transforms | signs | appends", "required": false, "schema": { "type": "string" } }, { "name": "setting", "in": "query", "description": "Additional details about where the content was created (e.g. clinical specialty)", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "related", "in": "query", "description": "Related identifiers or resources", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Main clinical acts documented", "required": false, "schema": { "type": "string" } }, { "name": "relationship", "in": "query", "description": "Combination of relation and relatesTo", "required": false, "schema": { "type": "string" } }, { "name": "authenticator", "in": "query", "description": "Who/what authenticated the document", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Time of service that is being documented", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "custodian", "in": "query", "description": "Organization which maintains the document", "required": false, "schema": { "type": "string" } }, { "name": "author", "in": "query", "description": "Who and/or what authored the document", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Format/content rules for the document", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "contenttype", "in": "query", "description": "Mime type of the content, with charset etc.", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "security-label", "in": "query", "description": "Document security-tags", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Uri where the data can be found", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Categorization of document", "required": false, "schema": { "type": "string" } }, { "name": "relatesto", "in": "query", "description": "Target of the relationship", "required": false, "schema": { "type": "string" } }, { "name": "facility", "in": "query", "description": "Kind of facility where patient was seen", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "current | superseded | entered-in-error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/$validate": { "get": { "tags": [ "DocumentReference" ], "summary": "GET: /DocumentReference/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"DocumentReference\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$validate": { "get": { "tags": [ "DocumentReference" ], "summary": "GET: /DocumentReference/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"DocumentReference\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$meta-delete": { "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$meta-add": { "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/$meta": { "get": { "tags": [ "DocumentReference" ], "summary": "GET: /DocumentReference/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$meta": { "get": { "tags": [ "DocumentReference" ], "summary": "GET: /DocumentReference/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/$expunge": { "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$expunge": { "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$diff": { "get": { "tags": [ "DocumentReference" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$reindex-dryrun": { "get": { "tags": [ "DocumentReference" ], "summary": "GET: /DocumentReference/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$reindex": { "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/DocumentReference/{id}/$graphql": { "get": { "tags": [ "DocumentReference" ], "summary": "GET: /DocumentReference/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } }, "post": { "tags": [ "DocumentReference" ], "summary": "POST: /DocumentReference/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } } } } } }, "/Medication/{id}": { "get": { "tags": [ "Medication" ], "summary": "read-instance: Read Medication instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "put": { "tags": [ "Medication" ], "summary": "update-instance: Update an existing Medication instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" }, "example": "{\n \"resourceType\": \"Medication\",\n \"text\": {\n \"status\": \"generated\"\n }\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" }, "example": "\n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "delete": { "tags": [ "Medication" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "patch": { "tags": [ "Medication" ], "summary": "instance-patch: Patch a resource instance of type Medication by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/_history/{version_id}": { "get": { "tags": [ "Medication" ], "summary": "vread-instance: Read Medication instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication": { "get": { "tags": [ "Medication" ], "summary": "search-type: Search for Medication instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Returns medications with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "ingredient", "in": "query", "description": "Returns medications for this ingredient reference", "required": false, "schema": { "type": "string" } }, { "name": "lot-number", "in": "query", "description": "Returns medications in a batch with this lot number", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Returns medications made or sold for this manufacturer", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "ingredient-code", "in": "query", "description": "Returns medications for this ingredient code", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "form", "in": "query", "description": "Returns medications for a specific dose form", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "expiration-date", "in": "query", "description": "Returns medications in a batch with this expiration date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "status", "in": "query", "description": "Returns medications for this status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "create-type: Create a new Medication instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" }, "example": "{\n \"resourceType\": \"Medication\",\n \"text\": {\n \"status\": \"generated\"\n }\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" }, "example": "\n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/_history": { "get": { "tags": [ "Medication" ], "summary": "type-history: Fetch the resource change history for all resources of type Medication", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/_history": { "get": { "tags": [ "Medication" ], "summary": "instance-history: Fetch the resource change history for all resources of type Medication", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/_search": { "get": { "tags": [ "Medication" ], "summary": "search-type: Search for Medication instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Returns medications with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "ingredient", "in": "query", "description": "Returns medications for this ingredient reference", "required": false, "schema": { "type": "string" } }, { "name": "lot-number", "in": "query", "description": "Returns medications in a batch with this lot number", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Returns medications made or sold for this manufacturer", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "ingredient-code", "in": "query", "description": "Returns medications for this ingredient code", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "form", "in": "query", "description": "Returns medications for a specific dose form", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "expiration-date", "in": "query", "description": "Returns medications in a batch with this expiration date", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "status", "in": "query", "description": "Returns medications for this status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/$validate": { "get": { "tags": [ "Medication" ], "summary": "GET: /Medication/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Medication\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$validate": { "get": { "tags": [ "Medication" ], "summary": "GET: /Medication/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Medication\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$meta-delete": { "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$meta-add": { "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/$meta": { "get": { "tags": [ "Medication" ], "summary": "GET: /Medication/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$meta": { "get": { "tags": [ "Medication" ], "summary": "GET: /Medication/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/$expunge": { "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$expunge": { "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$diff": { "get": { "tags": [ "Medication" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$reindex-dryrun": { "get": { "tags": [ "Medication" ], "summary": "GET: /Medication/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$reindex": { "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Medication/{id}/$graphql": { "get": { "tags": [ "Medication" ], "summary": "GET: /Medication/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } }, "post": { "tags": [ "Medication" ], "summary": "POST: /Medication/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Medication" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Medication" } } } } } } }, "/Immunization/{id}": { "get": { "tags": [ "Immunization" ], "summary": "read-instance: Read Immunization instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "put": { "tags": [ "Immunization" ], "summary": "update-instance: Update an existing Immunization instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" }, "example": "{\n \"resourceType\": \"Immunization\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "delete": { "tags": [ "Immunization" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "patch": { "tags": [ "Immunization" ], "summary": "instance-patch: Patch a resource instance of type Immunization by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/_history/{version_id}": { "get": { "tags": [ "Immunization" ], "summary": "vread-instance: Read Immunization instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization": { "get": { "tags": [ "Immunization" ], "summary": "search-type: Search for Immunization instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "lot-number", "in": "query", "description": "Vaccine Lot Number", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "status-reason", "in": "query", "description": "Reason why the vaccine was not administered", "required": false, "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Reason why the vaccine was administered", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Vaccine Manufacturer", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "reaction-date", "in": "query", "description": "When reaction started", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "The practitioner or organization who played a role in the vaccination", "required": false, "schema": { "type": "string" } }, { "name": "reaction", "in": "query", "description": "Additional information on reaction", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "target-disease", "in": "query", "description": "The target disease the dose is being administered against", "required": false, "schema": { "type": "string" } }, { "name": "series", "in": "query", "description": "The series being followed by the provider", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "vaccine-code", "in": "query", "description": "Vaccine Product Administered", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "Why immunization occurred", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "The service delivery location or facility in which the vaccine was / was to be administered", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Immunization event status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "create-type: Create a new Immunization instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" }, "example": "{\n \"resourceType\": \"Immunization\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/_history": { "get": { "tags": [ "Immunization" ], "summary": "type-history: Fetch the resource change history for all resources of type Immunization", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/_history": { "get": { "tags": [ "Immunization" ], "summary": "instance-history: Fetch the resource change history for all resources of type Immunization", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/_search": { "get": { "tags": [ "Immunization" ], "summary": "search-type: Search for Immunization instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "lot-number", "in": "query", "description": "Vaccine Lot Number", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "status-reason", "in": "query", "description": "Reason why the vaccine was not administered", "required": false, "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Reason why the vaccine was administered", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Vaccine Manufacturer", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "reaction-date", "in": "query", "description": "When reaction started", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "The practitioner or organization who played a role in the vaccination", "required": false, "schema": { "type": "string" } }, { "name": "reaction", "in": "query", "description": "Additional information on reaction", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "target-disease", "in": "query", "description": "The target disease the dose is being administered against", "required": false, "schema": { "type": "string" } }, { "name": "series", "in": "query", "description": "The series being followed by the provider", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "vaccine-code", "in": "query", "description": "Vaccine Product Administered", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "Why immunization occurred", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "The service delivery location or facility in which the vaccine was / was to be administered", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Immunization event status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/$validate": { "get": { "tags": [ "Immunization" ], "summary": "GET: /Immunization/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Immunization\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$validate": { "get": { "tags": [ "Immunization" ], "summary": "GET: /Immunization/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Immunization\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$meta-delete": { "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$meta-add": { "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/$meta": { "get": { "tags": [ "Immunization" ], "summary": "GET: /Immunization/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$meta": { "get": { "tags": [ "Immunization" ], "summary": "GET: /Immunization/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/$expunge": { "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$expunge": { "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$diff": { "get": { "tags": [ "Immunization" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$reindex-dryrun": { "get": { "tags": [ "Immunization" ], "summary": "GET: /Immunization/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$reindex": { "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/Immunization/{id}/$graphql": { "get": { "tags": [ "Immunization" ], "summary": "GET: /Immunization/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } }, "post": { "tags": [ "Immunization" ], "summary": "POST: /Immunization/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Immunization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Immunization" } } } } } } }, "/ImmunizationEvaluation/{id}": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "read-instance: Read ImmunizationEvaluation instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "put": { "tags": [ "ImmunizationEvaluation" ], "summary": "update-instance: Update an existing ImmunizationEvaluation instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" }, "example": "{\n \"resourceType\": \"ImmunizationEvaluation\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "delete": { "tags": [ "ImmunizationEvaluation" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "patch": { "tags": [ "ImmunizationEvaluation" ], "summary": "instance-patch: Patch a resource instance of type ImmunizationEvaluation by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/_history/{version_id}": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "vread-instance: Read ImmunizationEvaluation instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "search-type: Search for ImmunizationEvaluation instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Date the evaluation was generated", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "ID of the evaluation", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "dose-status", "in": "query", "description": "The status of the dose relative to published recommendations", "required": false, "schema": { "type": "string" } }, { "name": "immunization-event", "in": "query", "description": "The vaccine administration event being evaluated", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "target-disease", "in": "query", "description": "The vaccine preventable disease being evaluated against", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient being evaluated", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Immunization evaluation status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "create-type: Create a new ImmunizationEvaluation instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" }, "example": "{\n \"resourceType\": \"ImmunizationEvaluation\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/_history": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "type-history: Fetch the resource change history for all resources of type ImmunizationEvaluation", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/_history": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "instance-history: Fetch the resource change history for all resources of type ImmunizationEvaluation", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/_search": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "search-type: Search for ImmunizationEvaluation instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Date the evaluation was generated", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "ID of the evaluation", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "dose-status", "in": "query", "description": "The status of the dose relative to published recommendations", "required": false, "schema": { "type": "string" } }, { "name": "immunization-event", "in": "query", "description": "The vaccine administration event being evaluated", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "target-disease", "in": "query", "description": "The vaccine preventable disease being evaluated against", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient being evaluated", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Immunization evaluation status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/$validate": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "GET: /ImmunizationEvaluation/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"ImmunizationEvaluation\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$validate": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "GET: /ImmunizationEvaluation/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"ImmunizationEvaluation\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$meta-delete": { "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$meta-add": { "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/$meta": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "GET: /ImmunizationEvaluation/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$meta": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "GET: /ImmunizationEvaluation/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/$expunge": { "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$expunge": { "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$diff": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$reindex-dryrun": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "GET: /ImmunizationEvaluation/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$reindex": { "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationEvaluation/{id}/$graphql": { "get": { "tags": [ "ImmunizationEvaluation" ], "summary": "GET: /ImmunizationEvaluation/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } }, "post": { "tags": [ "ImmunizationEvaluation" ], "summary": "POST: /ImmunizationEvaluation/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } } } } } } }, "/ImmunizationRecommendation/{id}": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "read-instance: Read ImmunizationRecommendation instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationEvaluation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "put": { "tags": [ "ImmunizationRecommendation" ], "summary": "update-instance: Update an existing ImmunizationRecommendation instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" }, "example": "{\n \"resourceType\": \"ImmunizationRecommendation\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "delete": { "tags": [ "ImmunizationRecommendation" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "patch": { "tags": [ "ImmunizationRecommendation" ], "summary": "instance-patch: Patch a resource instance of type ImmunizationRecommendation by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/_history/{version_id}": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "vread-instance: Read ImmunizationRecommendation instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "search-type: Search for ImmunizationRecommendation instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Date recommendation(s) created", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Business identifier", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "vaccine-type", "in": "query", "description": "Vaccine or vaccine group recommendation applies to", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "target-disease", "in": "query", "description": "Disease to be immunized against", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Who this profile is for", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "information", "in": "query", "description": "Patient observations supporting recommendation", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "support", "in": "query", "description": "Past immunizations supporting recommendation", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Vaccine recommendation status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "create-type: Create a new ImmunizationRecommendation instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" }, "example": "{\n \"resourceType\": \"ImmunizationRecommendation\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/_history": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "type-history: Fetch the resource change history for all resources of type ImmunizationRecommendation", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/_history": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "instance-history: Fetch the resource change history for all resources of type ImmunizationRecommendation", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/_search": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "search-type: Search for ImmunizationRecommendation instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Date recommendation(s) created", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Business identifier", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "vaccine-type", "in": "query", "description": "Vaccine or vaccine group recommendation applies to", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "target-disease", "in": "query", "description": "Disease to be immunized against", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Who this profile is for", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "information", "in": "query", "description": "Patient observations supporting recommendation", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "support", "in": "query", "description": "Past immunizations supporting recommendation", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Vaccine recommendation status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/$validate": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "GET: /ImmunizationRecommendation/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"ImmunizationRecommendation\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$validate": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "GET: /ImmunizationRecommendation/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"ImmunizationRecommendation\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$meta-delete": { "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$meta-add": { "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/$meta": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "GET: /ImmunizationRecommendation/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$meta": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "GET: /ImmunizationRecommendation/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/$expunge": { "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$expunge": { "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$diff": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$reindex-dryrun": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "GET: /ImmunizationRecommendation/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$reindex": { "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/ImmunizationRecommendation/{id}/$graphql": { "get": { "tags": [ "ImmunizationRecommendation" ], "summary": "GET: /ImmunizationRecommendation/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } }, "post": { "tags": [ "ImmunizationRecommendation" ], "summary": "POST: /ImmunizationRecommendation/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ImmunizationRecommendation" } } } } } } }, "/Organization/{id}": { "get": { "tags": [ "Organization" ], "summary": "read-instance: Read Organization instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "put": { "tags": [ "Organization" ], "summary": "update-instance: Update an existing Organization instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": "{\n \"resourceType\": \"Organization\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "delete": { "tags": [ "Organization" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "patch": { "tags": [ "Organization" ], "summary": "instance-patch: Patch a resource instance of type Organization by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/_history/{version_id}": { "get": { "tags": [ "Organization" ], "summary": "vread-instance: Read Organization instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization": { "get": { "tags": [ "Organization" ], "summary": "search-type: Search for Organization instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "A state specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "type", "in": "query", "description": "A code for the type of organization", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "query", "description": "A country specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Technical endpoints providing access to services operated for the organization", "required": false, "schema": { "type": "string" } }, { "name": "phonetic", "in": "query", "description": "A portion of the organization's name using some kind of phonetic matching algorithm", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Any identifier for the organization (not the accreditation issuer's identifier)", "required": false, "schema": { "type": "string" } }, { "name": "partof", "in": "query", "description": "An organization of which this organization forms a part", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Is the Organization record active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "query", "description": "A use code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A portion of the organization's name or alias", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "create-type: Create a new Organization instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": "{\n \"resourceType\": \"Organization\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/_history": { "get": { "tags": [ "Organization" ], "summary": "type-history: Fetch the resource change history for all resources of type Organization", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/_history": { "get": { "tags": [ "Organization" ], "summary": "instance-history: Fetch the resource change history for all resources of type Organization", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/_search": { "get": { "tags": [ "Organization" ], "summary": "search-type: Search for Organization instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "A state specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "type", "in": "query", "description": "A code for the type of organization", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "query", "description": "A country specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Technical endpoints providing access to services operated for the organization", "required": false, "schema": { "type": "string" } }, { "name": "phonetic", "in": "query", "description": "A portion of the organization's name using some kind of phonetic matching algorithm", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Any identifier for the organization (not the accreditation issuer's identifier)", "required": false, "schema": { "type": "string" } }, { "name": "partof", "in": "query", "description": "An organization of which this organization forms a part", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Is the Organization record active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "query", "description": "A use code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A portion of the organization's name or alias", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/$validate": { "get": { "tags": [ "Organization" ], "summary": "GET: /Organization/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Organization\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$validate": { "get": { "tags": [ "Organization" ], "summary": "GET: /Organization/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Organization\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$meta-delete": { "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$meta-add": { "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/$meta": { "get": { "tags": [ "Organization" ], "summary": "GET: /Organization/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$meta": { "get": { "tags": [ "Organization" ], "summary": "GET: /Organization/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/$expunge": { "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$expunge": { "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$diff": { "get": { "tags": [ "Organization" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$reindex-dryrun": { "get": { "tags": [ "Organization" ], "summary": "GET: /Organization/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$reindex": { "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Organization/{id}/$graphql": { "get": { "tags": [ "Organization" ], "summary": "GET: /Organization/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } }, "post": { "tags": [ "Organization" ], "summary": "POST: /Organization/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Organization" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Organization" } } } } } } }, "/Practitioner/{id}": { "get": { "tags": [ "Practitioner" ], "summary": "read-instance: Read Practitioner instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "put": { "tags": [ "Practitioner" ], "summary": "update-instance: Update an existing Practitioner instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" }, "example": "{\n \"resourceType\": \"Practitioner\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "delete": { "tags": [ "Practitioner" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "patch": { "tags": [ "Practitioner" ], "summary": "instance-patch: Patch a resource instance of type Practitioner by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/_history/{version_id}": { "get": { "tags": [ "Practitioner" ], "summary": "vread-instance: Read Practitioner instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner": { "get": { "tags": [ "Practitioner" ], "summary": "search-type: Search for Practitioner instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "address-country", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "phonetic", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "communication", "in": "query", "description": "One of the languages that the practitioner can communicate with", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "given", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A practitioner's Identifier", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether the practitioner record is active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "family", "in": "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "create-type: Create a new Practitioner instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" }, "example": "{\n \"resourceType\": \"Practitioner\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/_history": { "get": { "tags": [ "Practitioner" ], "summary": "type-history: Fetch the resource change history for all resources of type Practitioner", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/_history": { "get": { "tags": [ "Practitioner" ], "summary": "instance-history: Fetch the resource change history for all resources of type Practitioner", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/_search": { "get": { "tags": [ "Practitioner" ], "summary": "search-type: Search for Practitioner instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "address-country", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "phonetic", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "communication", "in": "query", "description": "One of the languages that the practitioner can communicate with", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "given", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A practitioner's Identifier", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether the practitioner record is active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "family", "in": "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/$validate": { "get": { "tags": [ "Practitioner" ], "summary": "GET: /Practitioner/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Practitioner\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$validate": { "get": { "tags": [ "Practitioner" ], "summary": "GET: /Practitioner/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Practitioner\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$meta-delete": { "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$meta-add": { "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/$meta": { "get": { "tags": [ "Practitioner" ], "summary": "GET: /Practitioner/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$meta": { "get": { "tags": [ "Practitioner" ], "summary": "GET: /Practitioner/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/$expunge": { "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$expunge": { "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$diff": { "get": { "tags": [ "Practitioner" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$reindex-dryrun": { "get": { "tags": [ "Practitioner" ], "summary": "GET: /Practitioner/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$reindex": { "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/Practitioner/{id}/$graphql": { "get": { "tags": [ "Practitioner" ], "summary": "GET: /Practitioner/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } }, "post": { "tags": [ "Practitioner" ], "summary": "POST: /Practitioner/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Practitioner" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } } } }, "/PractitionerRole/{id}": { "get": { "tags": [ "PractitionerRole" ], "summary": "read-instance: Read PractitionerRole instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "put": { "tags": [ "PractitionerRole" ], "summary": "update-instance: Update an existing PractitionerRole instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" }, "example": "{\n \"resourceType\": \"PractitionerRole\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "delete": { "tags": [ "PractitionerRole" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "patch": { "tags": [ "PractitionerRole" ], "summary": "instance-patch: Patch a resource instance of type PractitionerRole by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/_history/{version_id}": { "get": { "tags": [ "PractitionerRole" ], "summary": "vread-instance: Read PractitionerRole instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole": { "get": { "tags": [ "PractitionerRole" ], "summary": "search-type: Search for PractitionerRole instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "The period during which the practitioner is authorized to perform in these role(s)", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "specialty", "in": "query", "description": "The practitioner has this specialty at an organization", "required": false, "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "The practitioner can perform this role at for the organization", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Technical endpoints providing access to services operated for the practitioner with this role", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A practitioner's Identifier", "required": false, "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "description": "Practitioner that is able to provide the defined services for the organization", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether this practitioner role record is in active use", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The identity of the organization the practitioner represents / acts on behalf of", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "One of the locations at which this practitioner provides care", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "create-type: Create a new PractitionerRole instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" }, "example": "{\n \"resourceType\": \"PractitionerRole\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/_history": { "get": { "tags": [ "PractitionerRole" ], "summary": "type-history: Fetch the resource change history for all resources of type PractitionerRole", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/_history": { "get": { "tags": [ "PractitionerRole" ], "summary": "instance-history: Fetch the resource change history for all resources of type PractitionerRole", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/_search": { "get": { "tags": [ "PractitionerRole" ], "summary": "search-type: Search for PractitionerRole instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "The period during which the practitioner is authorized to perform in these role(s)", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "specialty", "in": "query", "description": "The practitioner has this specialty at an organization", "required": false, "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "The practitioner can perform this role at for the organization", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Technical endpoints providing access to services operated for the practitioner with this role", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A practitioner's Identifier", "required": false, "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "description": "Practitioner that is able to provide the defined services for the organization", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether this practitioner role record is in active use", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The identity of the organization the practitioner represents / acts on behalf of", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "One of the locations at which this practitioner provides care", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/$validate": { "get": { "tags": [ "PractitionerRole" ], "summary": "GET: /PractitionerRole/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"PractitionerRole\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$validate": { "get": { "tags": [ "PractitionerRole" ], "summary": "GET: /PractitionerRole/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"PractitionerRole\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$meta-delete": { "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$meta-add": { "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/$meta": { "get": { "tags": [ "PractitionerRole" ], "summary": "GET: /PractitionerRole/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$meta": { "get": { "tags": [ "PractitionerRole" ], "summary": "GET: /PractitionerRole/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/$expunge": { "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$expunge": { "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$diff": { "get": { "tags": [ "PractitionerRole" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$reindex-dryrun": { "get": { "tags": [ "PractitionerRole" ], "summary": "GET: /PractitionerRole/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$reindex": { "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/PractitionerRole/{id}/$graphql": { "get": { "tags": [ "PractitionerRole" ], "summary": "GET: /PractitionerRole/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } }, "post": { "tags": [ "PractitionerRole" ], "summary": "POST: /PractitionerRole/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/PractitionerRole" } } } } } } }, "/Procedure/{id}": { "get": { "tags": [ "Procedure" ], "summary": "read-instance: Read Procedure instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "put": { "tags": [ "Procedure" ], "summary": "update-instance: Update an existing Procedure instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" }, "example": "{\n \"resourceType\": \"Procedure\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "delete": { "tags": [ "Procedure" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "patch": { "tags": [ "Procedure" ], "summary": "instance-patch: Patch a resource instance of type Procedure by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/_history/{version_id}": { "get": { "tags": [ "Procedure" ], "summary": "vread-instance: Read Procedure instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure": { "get": { "tags": [ "Procedure" ], "summary": "search-type: Search for Procedure instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search by subject", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "part-of", "in": "query", "description": "Part of referenced event", "required": false, "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Coded reason procedure performed", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "A request for this procedure", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "The reference to the practitioner", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "The justification that the procedure was performed", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Where the procedure happened", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Classification of the procedure", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "create-type: Create a new Procedure instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" }, "example": "{\n \"resourceType\": \"Procedure\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/_history": { "get": { "tags": [ "Procedure" ], "summary": "type-history: Fetch the resource change history for all resources of type Procedure", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/_history": { "get": { "tags": [ "Procedure" ], "summary": "instance-history: Fetch the resource change history for all resources of type Procedure", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/_search": { "get": { "tags": [ "Procedure" ], "summary": "search-type: Search for Procedure instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search by subject", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "part-of", "in": "query", "description": "Part of referenced event", "required": false, "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Coded reason procedure performed", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "A request for this procedure", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "The reference to the practitioner", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "The justification that the procedure was performed", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Where the procedure happened", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Classification of the procedure", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/$validate": { "get": { "tags": [ "Procedure" ], "summary": "GET: /Procedure/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Procedure\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$validate": { "get": { "tags": [ "Procedure" ], "summary": "GET: /Procedure/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Procedure\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$meta-delete": { "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$meta-add": { "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/$meta": { "get": { "tags": [ "Procedure" ], "summary": "GET: /Procedure/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$meta": { "get": { "tags": [ "Procedure" ], "summary": "GET: /Procedure/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/$expunge": { "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$expunge": { "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$diff": { "get": { "tags": [ "Procedure" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$reindex-dryrun": { "get": { "tags": [ "Procedure" ], "summary": "GET: /Procedure/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$reindex": { "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Procedure/{id}/$graphql": { "get": { "tags": [ "Procedure" ], "summary": "GET: /Procedure/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } }, "post": { "tags": [ "Procedure" ], "summary": "POST: /Procedure/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Procedure" } } } } } } }, "/Provenance/{id}": { "get": { "tags": [ "Provenance" ], "summary": "read-instance: Read Provenance instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "put": { "tags": [ "Provenance" ], "summary": "update-instance: Update an existing Provenance instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" }, "example": "{\n \"resourceType\": \"Provenance\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "delete": { "tags": [ "Provenance" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "patch": { "tags": [ "Provenance" ], "summary": "instance-patch: Patch a resource instance of type Provenance by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/_history/{version_id}": { "get": { "tags": [ "Provenance" ], "summary": "vread-instance: Read Provenance instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance": { "get": { "tags": [ "Provenance" ], "summary": "search-type: Search for Provenance instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "agent-type", "in": "query", "description": "How the agent participated", "required": false, "schema": { "type": "string" } }, { "name": "agent", "in": "query", "description": "Who participated", "required": false, "schema": { "type": "string" } }, { "name": "signature-type", "in": "query", "description": "Indication of the reason the entity signed the object(s)", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "recorded", "in": "query", "description": "When the activity was recorded / updated", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "when", "in": "query", "description": "When the activity occurred", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "target", "in": "query", "description": "Target Reference(s) (usually version specific)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Target Reference(s) (usually version specific)", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Where the activity occurred, if relevant", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "agent-role", "in": "query", "description": "What the agents role was", "required": false, "schema": { "type": "string" } }, { "name": "entity", "in": "query", "description": "Identity of entity", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "create-type: Create a new Provenance instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" }, "example": "{\n \"resourceType\": \"Provenance\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/_history": { "get": { "tags": [ "Provenance" ], "summary": "type-history: Fetch the resource change history for all resources of type Provenance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/_history": { "get": { "tags": [ "Provenance" ], "summary": "instance-history: Fetch the resource change history for all resources of type Provenance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/_search": { "get": { "tags": [ "Provenance" ], "summary": "search-type: Search for Provenance instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "agent-type", "in": "query", "description": "How the agent participated", "required": false, "schema": { "type": "string" } }, { "name": "agent", "in": "query", "description": "Who participated", "required": false, "schema": { "type": "string" } }, { "name": "signature-type", "in": "query", "description": "Indication of the reason the entity signed the object(s)", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "recorded", "in": "query", "description": "When the activity was recorded / updated", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "when", "in": "query", "description": "When the activity occurred", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "target", "in": "query", "description": "Target Reference(s) (usually version specific)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Target Reference(s) (usually version specific)", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Where the activity occurred, if relevant", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "agent-role", "in": "query", "description": "What the agents role was", "required": false, "schema": { "type": "string" } }, { "name": "entity", "in": "query", "description": "Identity of entity", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/$validate": { "get": { "tags": [ "Provenance" ], "summary": "GET: /Provenance/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Provenance\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$validate": { "get": { "tags": [ "Provenance" ], "summary": "GET: /Provenance/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Provenance\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$meta-delete": { "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$meta-add": { "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/$meta": { "get": { "tags": [ "Provenance" ], "summary": "GET: /Provenance/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$meta": { "get": { "tags": [ "Provenance" ], "summary": "GET: /Provenance/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/$expunge": { "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$expunge": { "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$diff": { "get": { "tags": [ "Provenance" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$reindex-dryrun": { "get": { "tags": [ "Provenance" ], "summary": "GET: /Provenance/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$reindex": { "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Provenance/{id}/$graphql": { "get": { "tags": [ "Provenance" ], "summary": "GET: /Provenance/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } }, "post": { "tags": [ "Provenance" ], "summary": "POST: /Provenance/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Provenance" } } } } } } }, "/Location/{id}": { "get": { "tags": [ "Location" ], "summary": "read-instance: Read Location instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "put": { "tags": [ "Location" ], "summary": "update-instance: Update an existing Location instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "{\n \"resourceType\": \"Location\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "delete": { "tags": [ "Location" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "patch": { "tags": [ "Location" ], "summary": "instance-patch: Patch a resource instance of type Location by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/_history/{version_id}": { "get": { "tags": [ "Location" ], "summary": "vread-instance: Read Location instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location": { "get": { "tags": [ "Location" ], "summary": "search-type: Search for Location instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "A state specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "operational-status", "in": "query", "description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "A code for the type of location", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "query", "description": "A country specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Technical endpoints providing access to services operated for the location", "required": false, "schema": { "type": "string" } }, { "name": "near", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An identifier for the location", "required": false, "schema": { "type": "string" } }, { "name": "partof", "in": "query", "description": "A location of which this location is a part", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "A (part of the) address of the location", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Searches for locations that are managed by the provided organization", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "query", "description": "A use code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A portion of the location's name or alias", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Searches for locations with a specific kind of status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "create-type: Create a new Location instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "{\n \"resourceType\": \"Location\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/_history": { "get": { "tags": [ "Location" ], "summary": "type-history: Fetch the resource change history for all resources of type Location", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/_history": { "get": { "tags": [ "Location" ], "summary": "instance-history: Fetch the resource change history for all resources of type Location", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/_search": { "get": { "tags": [ "Location" ], "summary": "search-type: Search for Location instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "A state specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "operational-status", "in": "query", "description": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "A code for the type of location", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "query", "description": "A country specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "endpoint", "in": "query", "description": "Technical endpoints providing access to services operated for the location", "required": false, "schema": { "type": "string" } }, { "name": "near", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An identifier for the location", "required": false, "schema": { "type": "string" } }, { "name": "partof", "in": "query", "description": "A location of which this location is a part", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "A (part of the) address of the location", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "A postal code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Searches for locations that are managed by the provided organization", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "query", "description": "A use code specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A portion of the location's name or alias", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Searches for locations with a specific kind of status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/$validate": { "get": { "tags": [ "Location" ], "summary": "GET: /Location/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "POST: /Location/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Location\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$validate": { "get": { "tags": [ "Location" ], "summary": "GET: /Location/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Location\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$meta-delete": { "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$meta-add": { "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/$meta": { "get": { "tags": [ "Location" ], "summary": "GET: /Location/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "POST: /Location/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$meta": { "get": { "tags": [ "Location" ], "summary": "GET: /Location/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/$expunge": { "post": { "tags": [ "Location" ], "summary": "POST: /Location/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$expunge": { "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$diff": { "get": { "tags": [ "Location" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$reindex-dryrun": { "get": { "tags": [ "Location" ], "summary": "GET: /Location/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$reindex": { "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Location/{id}/$graphql": { "get": { "tags": [ "Location" ], "summary": "GET: /Location/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "post": { "tags": [ "Location" ], "summary": "POST: /Location/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Location" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/Device/{id}": { "get": { "tags": [ "Device" ], "summary": "read-instance: Read Device instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "put": { "tags": [ "Device" ], "summary": "update-instance: Update an existing Device instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" }, "example": "{\n \"resourceType\": \"Device\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "delete": { "tags": [ "Device" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "patch": { "tags": [ "Device" ], "summary": "instance-patch: Patch a resource instance of type Device by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/_history/{version_id}": { "get": { "tags": [ "Device" ], "summary": "vread-instance: Read Device instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device": { "get": { "tags": [ "Device" ], "summary": "search-type: Search for Device instances", "description": "This is a search type", "parameters": [ { "name": "udi-di", "in": "query", "description": "The udi Device Identifier (DI)", "required": false, "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Instance id from manufacturer, owner, and others", "required": false, "schema": { "type": "string" } }, { "name": "udi-carrier", "in": "query", "description": "UDI Barcode (RFID or other technology) string in *HRF* format.", "required": false, "schema": { "type": "string" } }, { "name": "device-name", "in": "query", "description": "A server defined search that may match any of the string fields in Device.deviceName or Device.type.", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The type of the device", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Network address to contact device", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "The manufacturer of the device", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Patient information, if the resource is affixed to a person", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The organization responsible for the device", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "A location, where the resource is found", "required": false, "schema": { "type": "string" } }, { "name": "model", "in": "query", "description": "The model of the device", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "active | inactive | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "create-type: Create a new Device instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" }, "example": "{\n \"resourceType\": \"Device\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/_history": { "get": { "tags": [ "Device" ], "summary": "type-history: Fetch the resource change history for all resources of type Device", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/_history": { "get": { "tags": [ "Device" ], "summary": "instance-history: Fetch the resource change history for all resources of type Device", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/_search": { "get": { "tags": [ "Device" ], "summary": "search-type: Search for Device instances", "description": "This is a search type", "parameters": [ { "name": "udi-di", "in": "query", "description": "The udi Device Identifier (DI)", "required": false, "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Instance id from manufacturer, owner, and others", "required": false, "schema": { "type": "string" } }, { "name": "udi-carrier", "in": "query", "description": "UDI Barcode (RFID or other technology) string in *HRF* format.", "required": false, "schema": { "type": "string" } }, { "name": "device-name", "in": "query", "description": "A server defined search that may match any of the string fields in Device.deviceName or Device.type.", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The type of the device", "required": false, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Network address to contact device", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "The manufacturer of the device", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Patient information, if the resource is affixed to a person", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The organization responsible for the device", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "A location, where the resource is found", "required": false, "schema": { "type": "string" } }, { "name": "model", "in": "query", "description": "The model of the device", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "active | inactive | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/$validate": { "get": { "tags": [ "Device" ], "summary": "GET: /Device/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "POST: /Device/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Device\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$validate": { "get": { "tags": [ "Device" ], "summary": "GET: /Device/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Device\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$meta-delete": { "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$meta-add": { "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/$meta": { "get": { "tags": [ "Device" ], "summary": "GET: /Device/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "POST: /Device/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$meta": { "get": { "tags": [ "Device" ], "summary": "GET: /Device/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/$expunge": { "post": { "tags": [ "Device" ], "summary": "POST: /Device/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$expunge": { "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$diff": { "get": { "tags": [ "Device" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$reindex-dryrun": { "get": { "tags": [ "Device" ], "summary": "GET: /Device/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$reindex": { "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Device/{id}/$graphql": { "get": { "tags": [ "Device" ], "summary": "GET: /Device/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } }, "post": { "tags": [ "Device" ], "summary": "POST: /Device/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Device" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Device" } } } } } } }, "/Goal/{id}": { "get": { "tags": [ "Goal" ], "summary": "read-instance: Read Goal instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "put": { "tags": [ "Goal" ], "summary": "update-instance: Update an existing Goal instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" }, "example": "{\n \"resourceType\": \"Goal\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "delete": { "tags": [ "Goal" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "patch": { "tags": [ "Goal" ], "summary": "instance-patch: Patch a resource instance of type Goal by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/_history/{version_id}": { "get": { "tags": [ "Goal" ], "summary": "vread-instance: Read Goal instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal": { "get": { "tags": [ "Goal" ], "summary": "search-type: Search for Goal instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who this goal is intended for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "start-date", "in": "query", "description": "When goal pursuit begins", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "lifecycle-status", "in": "query", "description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "achievement-status", "in": "query", "description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "E.g. Treatment, dietary, behavioral, etc.", "required": false, "schema": { "type": "string" } }, { "name": "target-date", "in": "query", "description": "Reach goal on or before", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "create-type: Create a new Goal instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" }, "example": "{\n \"resourceType\": \"Goal\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/_history": { "get": { "tags": [ "Goal" ], "summary": "type-history: Fetch the resource change history for all resources of type Goal", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/_history": { "get": { "tags": [ "Goal" ], "summary": "instance-history: Fetch the resource change history for all resources of type Goal", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/_search": { "get": { "tags": [ "Goal" ], "summary": "search-type: Search for Goal instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who this goal is intended for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "start-date", "in": "query", "description": "When goal pursuit begins", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "lifecycle-status", "in": "query", "description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "achievement-status", "in": "query", "description": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "E.g. Treatment, dietary, behavioral, etc.", "required": false, "schema": { "type": "string" } }, { "name": "target-date", "in": "query", "description": "Reach goal on or before", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/$validate": { "get": { "tags": [ "Goal" ], "summary": "GET: /Goal/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Goal\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$validate": { "get": { "tags": [ "Goal" ], "summary": "GET: /Goal/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Goal\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$meta-delete": { "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$meta-add": { "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/$meta": { "get": { "tags": [ "Goal" ], "summary": "GET: /Goal/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$meta": { "get": { "tags": [ "Goal" ], "summary": "GET: /Goal/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/$expunge": { "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$expunge": { "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$diff": { "get": { "tags": [ "Goal" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$reindex-dryrun": { "get": { "tags": [ "Goal" ], "summary": "GET: /Goal/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$reindex": { "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/Goal/{id}/$graphql": { "get": { "tags": [ "Goal" ], "summary": "GET: /Goal/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } }, "post": { "tags": [ "Goal" ], "summary": "POST: /Goal/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Goal" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Goal" } } } } } } }, "/QuestionnaireResponse/{id}": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "read-instance: Read QuestionnaireResponse instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "put": { "tags": [ "QuestionnaireResponse" ], "summary": "update-instance: Update an existing QuestionnaireResponse instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" }, "example": "{\n \"resourceType\": \"QuestionnaireResponse\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "delete": { "tags": [ "QuestionnaireResponse" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "patch": { "tags": [ "QuestionnaireResponse" ], "summary": "instance-patch: Patch a resource instance of type QuestionnaireResponse by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/_history/{version_id}": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "vread-instance: Read QuestionnaireResponse instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "search-type: Search for QuestionnaireResponse instances", "description": "This is a search type", "parameters": [ { "name": "authored", "in": "query", "description": "When the questionnaire response was last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The unique identifier for the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "questionnaire", "in": "query", "description": "The questionnaire the answers are provided for", "required": false, "schema": { "type": "string" } }, { "name": "author", "in": "query", "description": "The author of the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject of the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "part-of", "in": "query", "description": "Procedure or observation this questionnaire response was performed as a part of", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter associated with the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "The individual providing the information reflected in the questionnaire respose", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Plan/proposal/order fulfilled by this questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient that is the subject of the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the questionnaire response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "create-type: Create a new QuestionnaireResponse instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" }, "example": "{\n \"resourceType\": \"QuestionnaireResponse\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/_history": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "type-history: Fetch the resource change history for all resources of type QuestionnaireResponse", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/_history": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "instance-history: Fetch the resource change history for all resources of type QuestionnaireResponse", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/_search": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "search-type: Search for QuestionnaireResponse instances", "description": "This is a search type", "parameters": [ { "name": "authored", "in": "query", "description": "When the questionnaire response was last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The unique identifier for the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "questionnaire", "in": "query", "description": "The questionnaire the answers are provided for", "required": false, "schema": { "type": "string" } }, { "name": "author", "in": "query", "description": "The author of the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject of the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "part-of", "in": "query", "description": "Procedure or observation this questionnaire response was performed as a part of", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter associated with the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "The individual providing the information reflected in the questionnaire respose", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Plan/proposal/order fulfilled by this questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient that is the subject of the questionnaire response", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the questionnaire response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/$validate": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "GET: /QuestionnaireResponse/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"QuestionnaireResponse\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$validate": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "GET: /QuestionnaireResponse/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"QuestionnaireResponse\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$meta-delete": { "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$meta-add": { "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/$meta": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "GET: /QuestionnaireResponse/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$meta": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "GET: /QuestionnaireResponse/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/$expunge": { "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$expunge": { "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$diff": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$reindex-dryrun": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "GET: /QuestionnaireResponse/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$reindex": { "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/QuestionnaireResponse/{id}/$graphql": { "get": { "tags": [ "QuestionnaireResponse" ], "summary": "GET: /QuestionnaireResponse/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } }, "post": { "tags": [ "QuestionnaireResponse" ], "summary": "POST: /QuestionnaireResponse/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/QuestionnaireResponse" } } } } } } }, "/RelatedPerson/{id}": { "get": { "tags": [ "RelatedPerson" ], "summary": "read-instance: Read RelatedPerson instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "put": { "tags": [ "RelatedPerson" ], "summary": "update-instance: Update an existing RelatedPerson instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" }, "example": "{\n \"resourceType\": \"RelatedPerson\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "delete": { "tags": [ "RelatedPerson" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "patch": { "tags": [ "RelatedPerson" ], "summary": "instance-patch: Patch a resource instance of type RelatedPerson by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/_history/{version_id}": { "get": { "tags": [ "RelatedPerson" ], "summary": "vread-instance: Read RelatedPerson instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson": { "get": { "tags": [ "RelatedPerson" ], "summary": "search-type: Search for RelatedPerson instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "address-state", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "address-country", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "phonetic", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient this related person is related to", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "relationship", "in": "query", "description": "The relationship between the patient and the relatedperson", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An Identifier of the RelatedPerson", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Indicates if the related person record is active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "create-type: Create a new RelatedPerson instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" }, "example": "{\n \"resourceType\": \"RelatedPerson\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/_history": { "get": { "tags": [ "RelatedPerson" ], "summary": "type-history: Fetch the resource change history for all resources of type RelatedPerson", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/_history": { "get": { "tags": [ "RelatedPerson" ], "summary": "instance-history: Fetch the resource change history for all resources of type RelatedPerson", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/_search": { "get": { "tags": [ "RelatedPerson" ], "summary": "search-type: Search for RelatedPerson instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "address-state", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "address-country", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "phonetic", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient this related person is related to", "required": false, "schema": { "type": "string" } }, { "name": "telecom", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "address-city", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "relationship", "in": "query", "description": "The relationship between the patient and the relatedperson", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An Identifier of the RelatedPerson", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Indicates if the related person record is active", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "phone", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "address-use", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "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", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/$validate": { "get": { "tags": [ "RelatedPerson" ], "summary": "GET: /RelatedPerson/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"RelatedPerson\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$validate": { "get": { "tags": [ "RelatedPerson" ], "summary": "GET: /RelatedPerson/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"RelatedPerson\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$meta-delete": { "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$meta-add": { "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/$meta": { "get": { "tags": [ "RelatedPerson" ], "summary": "GET: /RelatedPerson/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$meta": { "get": { "tags": [ "RelatedPerson" ], "summary": "GET: /RelatedPerson/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/$expunge": { "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$expunge": { "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$diff": { "get": { "tags": [ "RelatedPerson" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$reindex-dryrun": { "get": { "tags": [ "RelatedPerson" ], "summary": "GET: /RelatedPerson/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$reindex": { "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/RelatedPerson/{id}/$graphql": { "get": { "tags": [ "RelatedPerson" ], "summary": "GET: /RelatedPerson/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } }, "post": { "tags": [ "RelatedPerson" ], "summary": "POST: /RelatedPerson/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/RelatedPerson" } } } } } } }, "/Coverage/{id}": { "get": { "tags": [ "Coverage" ], "summary": "read-instance: Read Coverage instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "put": { "tags": [ "Coverage" ], "summary": "update-instance: Update an existing Coverage instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" }, "example": "{\n \"resourceType\": \"Coverage\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "delete": { "tags": [ "Coverage" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "patch": { "tags": [ "Coverage" ], "summary": "instance-patch: Patch a resource instance of type Coverage by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/_history/{version_id}": { "get": { "tags": [ "Coverage" ], "summary": "vread-instance: Read Coverage instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage": { "get": { "tags": [ "Coverage" ], "summary": "search-type: Search for Coverage instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The primary identifier of the insured and the coverage", "required": false, "schema": { "type": "string" } }, { "name": "subscriber", "in": "query", "description": "Reference to the subscriber", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The kind of coverage (health plan, auto, Workers Compensation)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "payor", "in": "query", "description": "The identity of the insurer or party paying for services", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "beneficiary", "in": "query", "description": "Covered party", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Retrieve coverages for a patient", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "class-value", "in": "query", "description": "Value of the class (eg. Plan number, group number)", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "class-type", "in": "query", "description": "Coverage class (eg. plan, group)", "required": false, "schema": { "type": "string" } }, { "name": "dependent", "in": "query", "description": "Dependent number", "required": false, "schema": { "type": "string" } }, { "name": "policy-holder", "in": "query", "description": "Reference to the policyholder", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the Coverage", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "create-type: Create a new Coverage instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" }, "example": "{\n \"resourceType\": \"Coverage\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/_history": { "get": { "tags": [ "Coverage" ], "summary": "type-history: Fetch the resource change history for all resources of type Coverage", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/_history": { "get": { "tags": [ "Coverage" ], "summary": "instance-history: Fetch the resource change history for all resources of type Coverage", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/_search": { "get": { "tags": [ "Coverage" ], "summary": "search-type: Search for Coverage instances", "description": "This is a search type", "parameters": [ { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The primary identifier of the insured and the coverage", "required": false, "schema": { "type": "string" } }, { "name": "subscriber", "in": "query", "description": "Reference to the subscriber", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The kind of coverage (health plan, auto, Workers Compensation)", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "payor", "in": "query", "description": "The identity of the insurer or party paying for services", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "beneficiary", "in": "query", "description": "Covered party", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Retrieve coverages for a patient", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "class-value", "in": "query", "description": "Value of the class (eg. Plan number, group number)", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "class-type", "in": "query", "description": "Coverage class (eg. plan, group)", "required": false, "schema": { "type": "string" } }, { "name": "dependent", "in": "query", "description": "Dependent number", "required": false, "schema": { "type": "string" } }, { "name": "policy-holder", "in": "query", "description": "Reference to the policyholder", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the Coverage", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/$validate": { "get": { "tags": [ "Coverage" ], "summary": "GET: /Coverage/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Coverage\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$validate": { "get": { "tags": [ "Coverage" ], "summary": "GET: /Coverage/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Coverage\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$meta-delete": { "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$meta-add": { "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/$meta": { "get": { "tags": [ "Coverage" ], "summary": "GET: /Coverage/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$meta": { "get": { "tags": [ "Coverage" ], "summary": "GET: /Coverage/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/$expunge": { "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$expunge": { "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$diff": { "get": { "tags": [ "Coverage" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$reindex-dryrun": { "get": { "tags": [ "Coverage" ], "summary": "GET: /Coverage/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$reindex": { "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/Coverage/{id}/$graphql": { "get": { "tags": [ "Coverage" ], "summary": "GET: /Coverage/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } }, "post": { "tags": [ "Coverage" ], "summary": "POST: /Coverage/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Coverage" } } } } } } }, "/CarePlan/{id}": { "get": { "tags": [ "CarePlan" ], "summary": "read-instance: Read CarePlan instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "put": { "tags": [ "CarePlan" ], "summary": "update-instance: Update an existing CarePlan instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" }, "example": "{\n \"resourceType\": \"CarePlan\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "delete": { "tags": [ "CarePlan" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "patch": { "tags": [ "CarePlan" ], "summary": "instance-patch: Patch a resource instance of type CarePlan by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/_history/{version_id}": { "get": { "tags": [ "CarePlan" ], "summary": "vread-instance: Read CarePlan instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan": { "get": { "tags": [ "CarePlan" ], "summary": "search-type: Search for CarePlan instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "care-team", "in": "query", "description": "Who's involved in plan?", "required": false, "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who the care plan is for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "part-of", "in": "query", "description": "Part of referenced CarePlan", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Fulfills CarePlan", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "activity-date", "in": "query", "description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "activity-code", "in": "query", "description": "Detail type of activity", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "goal", "in": "query", "description": "Desired outcome of plan", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)", "required": false, "schema": { "type": "string" } }, { "name": "replaces", "in": "query", "description": "CarePlan replaced by this CarePlan", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "required": false, "schema": { "type": "string" } }, { "name": "intent", "in": "query", "description": "proposal | plan | order | option", "required": false, "schema": { "type": "string" } }, { "name": "activity-reference", "in": "query", "description": "Activity details defined in specific resource", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "condition", "in": "query", "description": "Health issues this plan addresses", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Type of plan", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "create-type: Create a new CarePlan instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" }, "example": "{\n \"resourceType\": \"CarePlan\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/_history": { "get": { "tags": [ "CarePlan" ], "summary": "type-history: Fetch the resource change history for all resources of type CarePlan", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/_history": { "get": { "tags": [ "CarePlan" ], "summary": "instance-history: Fetch the resource change history for all resources of type CarePlan", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/_search": { "get": { "tags": [ "CarePlan" ], "summary": "search-type: Search for CarePlan instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "care-team", "in": "query", "description": "Who's involved in plan?", "required": false, "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who the care plan is for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "part-of", "in": "query", "description": "Part of referenced CarePlan", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Fulfills CarePlan", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "activity-date", "in": "query", "description": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "activity-code", "in": "query", "description": "Detail type of activity", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "goal", "in": "query", "description": "Desired outcome of plan", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)", "required": false, "schema": { "type": "string" } }, { "name": "replaces", "in": "query", "description": "CarePlan replaced by this CarePlan", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "required": false, "schema": { "type": "string" } }, { "name": "intent", "in": "query", "description": "proposal | plan | order | option", "required": false, "schema": { "type": "string" } }, { "name": "activity-reference", "in": "query", "description": "Activity details defined in specific resource", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "condition", "in": "query", "description": "Health issues this plan addresses", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Type of plan", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/$validate": { "get": { "tags": [ "CarePlan" ], "summary": "GET: /CarePlan/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"CarePlan\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$validate": { "get": { "tags": [ "CarePlan" ], "summary": "GET: /CarePlan/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"CarePlan\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$meta-delete": { "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$meta-add": { "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/$meta": { "get": { "tags": [ "CarePlan" ], "summary": "GET: /CarePlan/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$meta": { "get": { "tags": [ "CarePlan" ], "summary": "GET: /CarePlan/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/$expunge": { "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$expunge": { "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$diff": { "get": { "tags": [ "CarePlan" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$reindex-dryrun": { "get": { "tags": [ "CarePlan" ], "summary": "GET: /CarePlan/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$reindex": { "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/CarePlan/{id}/$graphql": { "get": { "tags": [ "CarePlan" ], "summary": "GET: /CarePlan/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } }, "post": { "tags": [ "CarePlan" ], "summary": "POST: /CarePlan/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CarePlan" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CarePlan" } } } } } } }, "/Specimen/{id}": { "get": { "tags": [ "Specimen" ], "summary": "read-instance: Read Specimen instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "put": { "tags": [ "Specimen" ], "summary": "update-instance: Update an existing Specimen instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" }, "example": "{\n \"resourceType\": \"Specimen\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "delete": { "tags": [ "Specimen" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "patch": { "tags": [ "Specimen" ], "summary": "instance-patch: Patch a resource instance of type Specimen by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/_history/{version_id}": { "get": { "tags": [ "Specimen" ], "summary": "vread-instance: Read Specimen instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen": { "get": { "tags": [ "Specimen" ], "summary": "search-type: Search for Specimen instances", "description": "This is a search type", "parameters": [ { "name": "container", "in": "query", "description": "The kind of specimen container", "required": false, "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "container-id", "in": "query", "description": "The unique identifier associated with the specimen container", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The unique identifier associated with the specimen", "required": false, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "description": "The parent of the specimen", "required": false, "schema": { "type": "string" } }, { "name": "bodysite", "in": "query", "description": "The code for the body site from where the specimen originated", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject of the specimen", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "collected", "in": "query", "description": "The date the specimen was collected", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "accession", "in": "query", "description": "The accession number associated with the specimen", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The specimen type", "required": false, "schema": { "type": "string" } }, { "name": "collector", "in": "query", "description": "Who collected the specimen", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient the specimen comes from", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "available | unavailable | unsatisfactory | entered-in-error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "create-type: Create a new Specimen instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" }, "example": "{\n \"resourceType\": \"Specimen\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/_history": { "get": { "tags": [ "Specimen" ], "summary": "type-history: Fetch the resource change history for all resources of type Specimen", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/_history": { "get": { "tags": [ "Specimen" ], "summary": "instance-history: Fetch the resource change history for all resources of type Specimen", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/_search": { "get": { "tags": [ "Specimen" ], "summary": "search-type: Search for Specimen instances", "description": "This is a search type", "parameters": [ { "name": "container", "in": "query", "description": "The kind of specimen container", "required": false, "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "container-id", "in": "query", "description": "The unique identifier associated with the specimen container", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The unique identifier associated with the specimen", "required": false, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "description": "The parent of the specimen", "required": false, "schema": { "type": "string" } }, { "name": "bodysite", "in": "query", "description": "The code for the body site from where the specimen originated", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The subject of the specimen", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "collected", "in": "query", "description": "The date the specimen was collected", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "accession", "in": "query", "description": "The accession number associated with the specimen", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The specimen type", "required": false, "schema": { "type": "string" } }, { "name": "collector", "in": "query", "description": "Who collected the specimen", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient the specimen comes from", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "available | unavailable | unsatisfactory | entered-in-error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/$validate": { "get": { "tags": [ "Specimen" ], "summary": "GET: /Specimen/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Specimen\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$validate": { "get": { "tags": [ "Specimen" ], "summary": "GET: /Specimen/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"Specimen\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$meta-delete": { "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$meta-add": { "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/$meta": { "get": { "tags": [ "Specimen" ], "summary": "GET: /Specimen/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$meta": { "get": { "tags": [ "Specimen" ], "summary": "GET: /Specimen/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/$expunge": { "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$expunge": { "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$diff": { "get": { "tags": [ "Specimen" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$reindex-dryrun": { "get": { "tags": [ "Specimen" ], "summary": "GET: /Specimen/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$reindex": { "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/Specimen/{id}/$graphql": { "get": { "tags": [ "Specimen" ], "summary": "GET: /Specimen/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } }, "post": { "tags": [ "Specimen" ], "summary": "POST: /Specimen/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Specimen" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Specimen" } } } } } } }, "/ServiceRequest/{id}": { "get": { "tags": [ "ServiceRequest" ], "summary": "read-instance: Read ServiceRequest instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "put": { "tags": [ "ServiceRequest" ], "summary": "update-instance: Update an existing ServiceRequest instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" }, "example": "{\n \"resourceType\": \"ServiceRequest\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "delete": { "tags": [ "ServiceRequest" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "patch": { "tags": [ "ServiceRequest" ], "summary": "instance-patch: Patch a resource instance of type ServiceRequest by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/_history/{version_id}": { "get": { "tags": [ "ServiceRequest" ], "summary": "vread-instance: Read ServiceRequest instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest": { "get": { "tags": [ "ServiceRequest" ], "summary": "search-type: Search for ServiceRequest instances", "description": "This is a search type", "parameters": [ { "name": "authored", "in": "query", "description": "Date request signed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "requisition", "in": "query", "description": "Composite Request ID", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search by subject", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "occurrence", "in": "query", "description": "When service should occur", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "What request fulfills", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "specimen", "in": "query", "description": "Specimen to be tested", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "requester", "in": "query", "description": "Who/what is requesting service", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Requested performer", "required": false, "schema": { "type": "string" } }, { "name": "replaces", "in": "query", "description": "What request replaces", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "routine | urgent | asap | stat", "required": false, "schema": { "type": "string" } }, { "name": "intent", "in": "query", "description": "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option", "required": false, "schema": { "type": "string" } }, { "name": "performer-type", "in": "query", "description": "Performer role", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "body-site", "in": "query", "description": "Where procedure is going to be done", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Classification of service", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "create-type: Create a new ServiceRequest instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" }, "example": "{\n \"resourceType\": \"ServiceRequest\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/_history": { "get": { "tags": [ "ServiceRequest" ], "summary": "type-history: Fetch the resource change history for all resources of type ServiceRequest", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/_history": { "get": { "tags": [ "ServiceRequest" ], "summary": "instance-history: Fetch the resource change history for all resources of type ServiceRequest", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/_search": { "get": { "tags": [ "ServiceRequest" ], "summary": "search-type: Search for ServiceRequest instances", "description": "This is a search type", "parameters": [ { "name": "authored", "in": "query", "description": "Date request signed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered", "required": false, "schema": { "type": "string" } }, { "name": "requisition", "in": "query", "description": "Composite Request ID", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search by subject", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "occurrence", "in": "query", "description": "When service should occur", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "What request fulfills", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "specimen", "in": "query", "description": "Specimen to be tested", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "requester", "in": "query", "description": "Who/what is requesting service", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Requested performer", "required": false, "schema": { "type": "string" } }, { "name": "replaces", "in": "query", "description": "What request replaces", "required": false, "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier", "required": false, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "routine | urgent | asap | stat", "required": false, "schema": { "type": "string" } }, { "name": "intent", "in": "query", "description": "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option", "required": false, "schema": { "type": "string" } }, { "name": "performer-type", "in": "query", "description": "Performer role", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "body-site", "in": "query", "description": "Where procedure is going to be done", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Classification of service", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/$validate": { "get": { "tags": [ "ServiceRequest" ], "summary": "GET: /ServiceRequest/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"ServiceRequest\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$validate": { "get": { "tags": [ "ServiceRequest" ], "summary": "GET: /ServiceRequest/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"ServiceRequest\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$meta-delete": { "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$meta-add": { "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/$meta": { "get": { "tags": [ "ServiceRequest" ], "summary": "GET: /ServiceRequest/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$meta": { "get": { "tags": [ "ServiceRequest" ], "summary": "GET: /ServiceRequest/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/$expunge": { "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$expunge": { "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$diff": { "get": { "tags": [ "ServiceRequest" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$reindex-dryrun": { "get": { "tags": [ "ServiceRequest" ], "summary": "GET: /ServiceRequest/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$reindex": { "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/ServiceRequest/{id}/$graphql": { "get": { "tags": [ "ServiceRequest" ], "summary": "GET: /ServiceRequest/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } }, "post": { "tags": [ "ServiceRequest" ], "summary": "POST: /ServiceRequest/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/ServiceRequest" } } } } } } }, "/CareTeam/{id}": { "get": { "tags": [ "CareTeam" ], "summary": "read-instance: Read CareTeam instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "put": { "tags": [ "CareTeam" ], "summary": "update-instance: Update an existing CareTeam instance, or create using a client-assigned ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" }, "example": "{\n \"resourceType\": \"CareTeam\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "delete": { "tags": [ "CareTeam" ], "summary": "instance-delete: Perform a logical delete on a resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "patch": { "tags": [ "CareTeam" ], "summary": "instance-patch: Patch a resource instance of type CareTeam by ID", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" }, "example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/_history/{version_id}": { "get": { "tags": [ "CareTeam" ], "summary": "vread-instance: Read CareTeam instance with specific version", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "version_id", "in": "path", "description": "The resource version ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam": { "get": { "tags": [ "CareTeam" ], "summary": "search-type: Search for CareTeam instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who care team is for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Who is involved", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Type of team", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "proposed | active | suspended | inactive | entered-in-error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "create-type: Create a new CareTeam instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" }, "example": "{\n \"resourceType\": \"CareTeam\"\n}" }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" }, "example": "" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/_history": { "get": { "tags": [ "CareTeam" ], "summary": "type-history: Fetch the resource change history for all resources of type CareTeam", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/_history": { "get": { "tags": [ "CareTeam" ], "summary": "instance-history: Fetch the resource change history for all resources of type CareTeam", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/_search": { "get": { "tags": [ "CareTeam" ], "summary": "search-type: Search for CareTeam instances", "description": "This is a search type", "parameters": [ { "name": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_language", "in": "query", "description": "Language of the resource content", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier", "required": false, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who care team is for", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Who is involved", "required": false, "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource's data using a filter", "required": false, "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource's data using a list", "required": false, "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "required": false, "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for", "required": false, "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "required": false, "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "required": false, "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "required": false, "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "required": false, "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search on the narrative of the resource", "required": false, "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search on the entire content of the resource", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Type of team", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "proposed | active | suspended | inactive | entered-in-error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/$validate": { "get": { "tags": [ "CareTeam" ], "summary": "GET: /CareTeam/$validate", "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/$validate", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"CareTeam\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$validate": { "get": { "tags": [ "CareTeam" ], "summary": "GET: /CareTeam/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$validate", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"CareTeam\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$meta-delete": { "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$meta-delete", "description": "Delete tags, profiles, and/or security labels from a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$meta-add": { "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$meta-add", "description": "Add tags, profiles, and/or security labels to a resource", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/$meta": { "get": { "tags": [ "CareTeam" ], "summary": "GET: /CareTeam/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$meta": { "get": { "tags": [ "CareTeam" ], "summary": "GET: /CareTeam/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$meta", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/$expunge": { "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/$expunge", "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$expunge": { "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$expunge", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$diff": { "get": { "tags": [ "CareTeam" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "from", "in": "query", "description": "The resource ID and version to diff from", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/1" }, { "name": "to", "in": "query", "description": "The resource ID and version to diff to", "required": true, "schema": { "type": "string" }, "example": "Patient/example/version/2" }, { "name": "includeMeta", "in": "query", "description": "Should differences in the Resource.meta element be included in the diff", "required": false, "schema": { "type": "string" }, "example": "false" }, { "name": "fromVersion", "in": "query", "description": "The resource ID and version to diff from", "required": false, "schema": { "type": "string" }, "example": "Patient/example/version/1" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "Comparte two resources or two versions of a single resource", "description": "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.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"from\"\n }, {\n \"name\": \"to\"\n }, {\n \"name\": \"includeMeta\",\n \"valueBoolean\": false\n }, {\n \"name\": \"fromVersion\",\n \"valueString\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$reindex-dryrun": { "get": { "tags": [ "CareTeam" ], "summary": "GET: /CareTeam/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$reindex-dryrun", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"code\",\n \"valueCode\": \"example\"\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$reindex": { "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$reindex", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"url\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"reindexSearchParameters\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimizeStorage\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"optimisticLock\",\n \"valueBoolean\": false\n } ]\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } } }, "/CareTeam/{id}/$graphql": { "get": { "tags": [ "CareTeam" ], "summary": "GET: /CareTeam/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/CareTeam" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/CareTeam" } } } } } }, "post": { "tags": [ "CareTeam" ], "summary": "POST: /CareTeam/{id}/$graphql", "description": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.", "parameters": [ { "name": "id", "in": "path", "description": "The resource ID", "required": true, "style": "simple", "schema": { "minimum": 1, "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/fhir+json": { "schema": { "title": "FHIR Resource", "type": "object" }, "example": "{\n \"resourceType\": \"Parameters\"\n}" } } }, "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/Condition" } } } } } } }, "/Group": { "get": { "summary": "Search Groups", "description": "Search for Group resources. Represents a defined collection of entities that may be discussed or acted upon collectively.", "operationId": "searchGroups", "tags": ["Group"], "parameters": [ { "name": "identifier", "in": "query", "description": "Unique id", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "person | animal | practitioner | device | medication | substance", "schema": { "type": "string", "enum": ["person", "animal", "practitioner", "device", "medication", "substance"] } }, { "name": "actual", "in": "query", "description": "Descriptive or actual", "schema": { "type": "boolean" } }, { "name": "code", "in": "query", "description": "The kind of resources contained", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Search results", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Bundle" } } } } } } }, "/Group/{id}": { "get": { "summary": "Read Group", "description": "Read a specific Group resource by ID", "operationId": "readGroup", "tags": ["Group"], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Group resource ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Group resource", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "404": { "description": "Group not found" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "Resource": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "The type of the resource" }, "id": { "type": "string", "description": "Logical id of this artifact" }, "meta": { "$ref": "#/components/schemas/Meta" }, "implicitRules": { "type": "string", "format": "uri", "description": "A set of rules under which this content was created" }, "language": { "type": "string", "description": "Language of the resource content" } }, "required": ["resourceType"] }, "Meta": { "type": "object", "properties": { "versionId": { "type": "string", "description": "Version specific identifier" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "When the resource version last changed" }, "source": { "type": "string", "format": "uri", "description": "Identifies where the resource comes from" }, "profile": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "Profiles this resource claims to conform to" }, "security": { "type": "array", "items": { "$ref": "#/components/schemas/Coding" }, "description": "Security Labels applied to this resource" }, "tag": { "type": "array", "items": { "$ref": "#/components/schemas/Coding" }, "description": "Tags applied to this resource" } } }, "Patient": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "An identifier for this patient" }, "active": { "type": "boolean", "description": "Whether this patient record is in active use" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/HumanName" }, "description": "A name associated with the patient" }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPoint" }, "description": "A contact detail for the individual" }, "gender": { "type": "string", "enum": ["male", "female", "other", "unknown"], "description": "male | female | other | unknown" }, "birthDate": { "type": "string", "format": "date", "description": "The date of birth for the individual" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "An address for the individual" } } } ] }, "Observation": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Business Identifier for observation" }, "status": { "type": "string", "enum": ["registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown"], "description": "registered | preliminary | final | amended +" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Classification of type of observation" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Type of observation (code / type)" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who and/or what the observation is about" }, "effectiveDateTime": { "type": "string", "format": "date-time", "description": "Clinically relevant time/time-period for observation" }, "valueQuantity": { "$ref": "#/components/schemas/Quantity", "description": "Actual result" }, "valueString": { "type": "string", "description": "Actual result" } }, "required": ["status", "code"] } ] }, "Bundle": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Persistent identifier for the bundle" }, "type": { "type": "string", "enum": ["document", "message", "transaction", "transaction-response", "batch", "batch-response", "history", "searchset", "collection"], "description": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection" }, "timestamp": { "type": "string", "format": "date-time", "description": "When the bundle was assembled" }, "total": { "type": "integer", "description": "If search, the total number of matches" }, "link": { "type": "array", "items": { "$ref": "#/components/schemas/BundleLink" }, "description": "Links related to this Bundle" }, "entry": { "type": "array", "items": { "$ref": "#/components/schemas/BundleEntry" }, "description": "Entry in the bundle - will have a resource or information" } }, "required": ["type"] } ] }, "CapabilityStatement": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "Canonical identifier for this capability statement" }, "version": { "type": "string", "description": "Business version of the capability statement" }, "name": { "type": "string", "description": "Name for this capability statement" }, "title": { "type": "string", "description": "Name for this capability statement (human friendly)" }, "status": { "type": "string", "enum": ["draft", "active", "retired", "unknown"], "description": "draft | active | retired | unknown" }, "date": { "type": "string", "format": "date-time", "description": "Date last changed" }, "publisher": { "type": "string", "description": "Name of the publisher (organization or individual)" }, "kind": { "type": "string", "enum": ["instance", "capability", "requirements"], "description": "instance | capability | requirements" }, "software": { "$ref": "#/components/schemas/CapabilityStatementSoftware", "description": "Software that is covered by this capability statement" }, "fhirVersion": { "type": "string", "description": "FHIR Version the system supports" }, "format": { "type": "array", "items": { "type": "string" }, "description": "formats supported (xml | json | ttl | mime type)" }, "rest": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityStatementRest" }, "description": "If the endpoint is a RESTful one" } }, "required": ["status", "date", "kind", "fhirVersion", "format"] } ] }, "Identifier": { "type": "object", "properties": { "use": { "type": "string", "enum": ["usual", "official", "temp", "secondary", "old"], "description": "usual | official | temp | secondary | old (If known)" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Description of identifier" }, "system": { "type": "string", "format": "uri", "description": "The namespace for the identifier value" }, "value": { "type": "string", "description": "The value that is unique" } } }, "HumanName": { "type": "object", "properties": { "use": { "type": "string", "enum": ["usual", "official", "temp", "nickname", "anonymous", "old", "maiden"], "description": "usual | official | temp | nickname | anonymous | old | maiden" }, "text": { "type": "string", "description": "Text representation of the full name" }, "family": { "type": "string", "description": "Family name (often called 'Surname')" }, "given": { "type": "array", "items": { "type": "string" }, "description": "Given names (not always 'first'). Includes middle names" }, "prefix": { "type": "array", "items": { "type": "string" }, "description": "Parts that come before the name" }, "suffix": { "type": "array", "items": { "type": "string" }, "description": "Parts that come after the name" } } }, "ContactPoint": { "type": "object", "properties": { "system": { "type": "string", "enum": ["phone", "fax", "email", "pager", "url", "sms", "other"], "description": "phone | fax | email | pager | url | sms | other" }, "value": { "type": "string", "description": "The actual contact point details" }, "use": { "type": "string", "enum": ["home", "work", "temp", "old", "mobile"], "description": "home | work | temp | old | mobile - purpose of this contact point" } } }, "Address": { "type": "object", "properties": { "use": { "type": "string", "enum": ["home", "work", "temp", "old", "billing"], "description": "home | work | temp | old | billing - purpose of this address" }, "type": { "type": "string", "enum": ["postal", "physical", "both"], "description": "postal | physical | both" }, "text": { "type": "string", "description": "Text representation of the address" }, "line": { "type": "array", "items": { "type": "string" }, "description": "Street name, number, direction & P.O. Box etc." }, "city": { "type": "string", "description": "Name of city, town etc." }, "district": { "type": "string", "description": "District name (aka county)" }, "state": { "type": "string", "description": "Sub-unit of country (abbreviations ok)" }, "postalCode": { "type": "string", "description": "Postal code for area" }, "country": { "type": "string", "description": "Country (e.g. can be ISO 3166 2 or 3 letter code)" } } }, "CodeableConcept": { "type": "object", "properties": { "coding": { "type": "array", "items": { "$ref": "#/components/schemas/Coding" }, "description": "Code defined by a terminology system" }, "text": { "type": "string", "description": "Plain text representation of the concept" } } }, "Coding": { "type": "object", "properties": { "system": { "type": "string", "format": "uri", "description": "Identity of the terminology system" }, "version": { "type": "string", "description": "Version of the system - if relevant" }, "code": { "type": "string", "description": "Symbol in syntax defined by the system" }, "display": { "type": "string", "description": "Representation defined by the system" }, "userSelected": { "type": "boolean", "description": "If this coding was chosen directly by the user" } } }, "Reference": { "type": "object", "properties": { "reference": { "type": "string", "description": "Literal reference, Relative, internal or absolute URL" }, "type": { "type": "string", "format": "uri", "description": "Type the reference refers to (e.g. \"Patient\")" }, "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Logical reference, when literal reference is not known" }, "display": { "type": "string", "description": "Text alternative for the resource" } } }, "Quantity": { "type": "object", "properties": { "value": { "type": "number", "description": "Numerical value (with implicit precision)" }, "comparator": { "type": "string", "enum": ["<", "<=", ">=", ">"], "description": "< | <= | >= | > - how to understand the value" }, "unit": { "type": "string", "description": "Unit representation" }, "system": { "type": "string", "format": "uri", "description": "System that defines coded unit form" }, "code": { "type": "string", "description": "Coded form of the unit" } } }, "BundleLink": { "type": "object", "properties": { "relation": { "type": "string", "description": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1" }, "url": { "type": "string", "format": "uri", "description": "Reference details for the link" } }, "required": ["relation", "url"] }, "BundleEntry": { "type": "object", "properties": { "link": { "type": "array", "items": { "$ref": "#/components/schemas/BundleLink" }, "description": "Links related to this entry" }, "fullUrl": { "type": "string", "format": "uri", "description": "URI for resource (Absolute URL server address or URI for UUID/OID)" }, "resource": { "$ref": "#/components/schemas/Resource", "description": "A resource in the bundle" }, "search": { "$ref": "#/components/schemas/BundleEntrySearch", "description": "Search related information" } } }, "BundleEntrySearch": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["match", "include", "outcome"], "description": "match | include | outcome - why this is in the result set" }, "score": { "type": "number", "description": "Search ranking (between 0 and 1)" } } }, "CapabilityStatementSoftware": { "type": "object", "properties": { "name": { "type": "string", "description": "A name the software is known by" }, "version": { "type": "string", "description": "Version covered by this statement" }, "releaseDate": { "type": "string", "format": "date-time", "description": "Date this version was released" } }, "required": ["name"] }, "CapabilityStatementRest": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["client", "server"], "description": "client | server" }, "documentation": { "type": "string", "description": "General description of implementation" }, "security": { "$ref": "#/components/schemas/CapabilityStatementRestSecurity", "description": "Information about security of implementation" }, "resource": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityStatementRestResource" }, "description": "Resource served on the REST interface" } }, "required": ["mode"] }, "CapabilityStatementRestSecurity": { "type": "object", "properties": { "cors": { "type": "boolean", "description": "Adds CORS Headers (http://enable-cors.org/)" }, "service": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates" }, "description": { "type": "string", "description": "General description of how security works" } } }, "CapabilityStatementRestResource": { "type": "object", "properties": { "type": { "type": "string", "description": "A resource type that is supported" }, "profile": { "type": "string", "format": "uri", "description": "Base System profile for all uses of resource" }, "supportedProfile": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "Profiles for use cases supported" }, "documentation": { "type": "string", "description": "Additional information about the use of the resource type" }, "interaction": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityStatementRestResourceInteraction" }, "description": "What operations are supported?" }, "versioning": { "type": "string", "enum": ["no-version", "versioned", "versioned-update"], "description": "no-version | versioned | versioned-update" }, "readHistory": { "type": "boolean", "description": "Whether vRead can return past versions" }, "updateCreate": { "type": "boolean", "description": "If update can commit to a new identity" }, "conditionalCreate": { "type": "boolean", "description": "If allows/uses conditional create" }, "conditionalRead": { "type": "string", "enum": ["not-supported", "modified-since", "not-match", "full-support"], "description": "not-supported | modified-since | not-match | full-support" }, "conditionalUpdate": { "type": "boolean", "description": "If allows/uses conditional update" }, "conditionalDelete": { "type": "string", "enum": ["not-supported", "single", "multiple"], "description": "not-supported | single | multiple - how conditional delete is supported" }, "referencePolicy": { "type": "array", "items": { "type": "string", "enum": ["literal", "logical", "resolves", "enforced", "local"] }, "description": "literal | logical | resolves | enforced | local" }, "searchInclude": { "type": "array", "items": { "type": "string" }, "description": "_include values supported by the server" }, "searchRevInclude": { "type": "array", "items": { "type": "string" }, "description": "_revinclude values supported by the server" }, "searchParam": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityStatementRestResourceSearchParam" }, "description": "Search parameters supported by implementation" } }, "required": ["type"] }, "CapabilityStatementRestResourceInteraction": { "type": "object", "properties": { "code": { "type": "string", "enum": ["read", "vread", "update", "patch", "delete", "history-instance", "history-type", "create", "search-type"], "description": "read | vread | update | patch | delete | history-instance | history-type | create | search-type" }, "documentation": { "type": "string", "description": "Anything special about operation behavior" } }, "required": ["code"] }, "CapabilityStatementRestResourceSearchParam": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of search parameter" }, "definition": { "type": "string", "format": "uri", "description": "Source of definition for parameter" }, "type": { "type": "string", "enum": ["number", "date", "string", "token", "reference", "composite", "quantity", "uri", "special"], "description": "number | date | string | token | reference | composite | quantity | uri | special" }, "documentation": { "type": "string", "description": "Server-specific usage" } }, "required": ["name", "type"] }, "Location": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Unique code or number identifying the location to its users" }, "status": { "type": "string", "enum": ["active", "suspended", "inactive"], "description": "active | suspended | inactive" }, "name": { "type": "string", "description": "Name of the location as used by humans" }, "alias": { "type": "array", "items": { "type": "string" }, "description": "A list of alternate names that the location is known as" }, "description": { "type": "string", "description": "Additional details about the location" }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Type of function performed" }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPoint" }, "description": "Contact details of the location" }, "address": { "$ref": "#/components/schemas/Address", "description": "Physical location" }, "managingOrganization": { "$ref": "#/components/schemas/Reference", "description": "Organization responsible for provisioning and upkeep" } } } ] }, "RelatedPerson": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "A human identifier for this person" }, "active": { "type": "boolean", "description": "Whether this related person record is in active use" }, "patient": { "$ref": "#/components/schemas/Reference", "description": "The patient this person is related to" }, "relationship": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "The nature of the relationship" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/HumanName" }, "description": "A name associated with the person" }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPoint" }, "description": "A contact detail for the person" }, "gender": { "type": "string", "enum": ["male", "female", "other", "unknown"], "description": "male | female | other | unknown" }, "birthDate": { "type": "string", "format": "date", "description": "The date on which the related person was born" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "Address where the related person can be contacted or visited" } }, "required": ["patient"] } ] }, "Device": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Instance identifiers" }, "status": { "type": "string", "enum": ["active", "inactive", "entered-in-error", "unknown"], "description": "active | inactive | entered-in-error | unknown" }, "deviceName": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the device" }, "type": { "type": "string", "enum": ["udi-label-name", "user-friendly-name", "patient-reported-name", "manufacturer-name", "model-name", "other"], "description": "udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other" } }, "required": ["name", "type"] }, "description": "The name of the device as given by the manufacturer" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "The kind or type of device" }, "manufacturer": { "type": "string", "description": "Name of device manufacturer" }, "manufactureDate": { "type": "string", "format": "date-time", "description": "Date when the device was made" }, "expirationDate": { "type": "string", "format": "date-time", "description": "Date and time of expiry of this device" }, "lotNumber": { "type": "string", "description": "Lot number of manufacture" }, "serialNumber": { "type": "string", "description": "Serial number assigned by the manufacturer" }, "owner": { "$ref": "#/components/schemas/Reference", "description": "Organization responsible for device" }, "patient": { "$ref": "#/components/schemas/Reference", "description": "Patient to whom Device is affixed" } } } ] }, "Goal": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External Ids for this goal" }, "lifecycleStatus": { "type": "string", "enum": ["proposed", "planned", "accepted", "active", "on-hold", "completed", "cancelled", "entered-in-error", "rejected"], "description": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "E.g. Treatment, dietary, behavioral, etc." }, "description": { "$ref": "#/components/schemas/CodeableConcept", "description": "Code or text describing goal" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who this goal is intended for" }, "target": { "type": "array", "items": { "type": "object", "properties": { "measure": { "$ref": "#/components/schemas/CodeableConcept", "description": "The parameter whose value is being tracked" }, "detailQuantity": { "$ref": "#/components/schemas/Quantity", "description": "The target value to be achieved" }, "dueDate": { "type": "string", "format": "date", "description": "Reach goal on or before" } } }, "description": "Target outcome for the goal" } }, "required": ["lifecycleStatus", "description", "subject"] } ] }, "QuestionnaireResponse": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Unique id for this set of answers" }, "questionnaire": { "type": "string", "format": "uri", "description": "Form being answered" }, "status": { "type": "string", "enum": ["in-progress", "completed", "amended", "entered-in-error", "stopped"], "description": "in-progress | completed | amended | entered-in-error | stopped" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "The subject of the questions" }, "authored": { "type": "string", "format": "date-time", "description": "Date the answers were gathered" }, "author": { "$ref": "#/components/schemas/Reference", "description": "Person who received and recorded the answers" }, "source": { "$ref": "#/components/schemas/Reference", "description": "The person who answered the questions" } }, "required": ["status"] } ] }, "Coverage": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Business Identifier for the coverage" }, "status": { "type": "string", "enum": ["active", "cancelled", "draft", "entered-in-error"], "description": "active | cancelled | draft | entered-in-error" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Coverage category such as medical or accident" }, "subscriber": { "$ref": "#/components/schemas/Reference", "description": "Subscriber to the policy" }, "subscriberId": { "type": "string", "description": "ID assigned to the subscriber" }, "beneficiary": { "$ref": "#/components/schemas/Reference", "description": "Plan beneficiary" }, "relationship": { "$ref": "#/components/schemas/CodeableConcept", "description": "Beneficiary relationship to the subscriber" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Coverage start and end dates" }, "payor": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Issuer of the policy" } }, "required": ["status", "beneficiary", "payor"] } ] }, "CarePlan": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External Ids for this plan" }, "status": { "type": "string", "enum": ["draft", "active", "on-hold", "revoked", "completed", "entered-in-error", "unknown"], "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown" }, "intent": { "type": "string", "enum": ["proposal", "plan", "order", "option"], "description": "proposal | plan | order | option" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Type of plan" }, "title": { "type": "string", "description": "Human-friendly name for the care plan" }, "description": { "type": "string", "description": "Summary of nature of plan" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who the care plan is for" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Time period plan covers" }, "created": { "type": "string", "format": "date-time", "description": "Date record was first recorded" }, "author": { "$ref": "#/components/schemas/Reference", "description": "Who is the designated responsible party" } }, "required": ["status", "intent", "subject"] } ] }, "Specimen": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External Identifier" }, "status": { "type": "string", "enum": ["available", "unavailable", "unsatisfactory", "entered-in-error"], "description": "available | unavailable | unsatisfactory | entered-in-error" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Kind of material that forms the specimen" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Where the specimen came from. This may be from patient(s), from a location, or from a sampling of the environment" }, "receivedTime": { "type": "string", "format": "date-time", "description": "The time when specimen was received for processing" }, "collection": { "type": "object", "properties": { "collector": { "$ref": "#/components/schemas/Reference", "description": "Who collected the specimen" }, "collectedDateTime": { "type": "string", "format": "date-time", "description": "Collection time" }, "method": { "$ref": "#/components/schemas/CodeableConcept", "description": "Technique used to perform collection" } }, "description": "Collection details" } } } ] }, "ServiceRequest": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Identifiers assigned to this order" }, "status": { "type": "string", "enum": ["draft", "active", "on-hold", "revoked", "completed", "entered-in-error", "unknown"], "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown" }, "intent": { "type": "string", "enum": ["proposal", "plan", "directive", "order", "original-order", "reflex-order", "filler-order", "instance-order", "option"], "description": "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Classification of service" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "What is being requested/ordered" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Individual or Entity the service is ordered for" }, "authoredOn": { "type": "string", "format": "date-time", "description": "Date request signed" }, "requester": { "$ref": "#/components/schemas/Reference", "description": "Who/what is requesting service" } }, "required": ["status", "intent", "subject"] } ] }, "CareTeam": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External Ids for this team" }, "status": { "type": "string", "enum": ["proposed", "active", "suspended", "inactive", "entered-in-error"], "description": "proposed | active | suspended | inactive | entered-in-error" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Type of team" }, "name": { "type": "string", "description": "Name of the team, such as crisis assessment team" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who care team is for" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Time period team covers" }, "participant": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Type of involvement" }, "member": { "$ref": "#/components/schemas/Reference", "description": "Who is involved" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Time period of participant" } } }, "description": "Members of the team" } } } ] }, "Group": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Unique id" }, "active": { "type": "boolean", "description": "Whether this group's record is in active use" }, "type": { "type": "string", "enum": ["person", "animal", "practitioner", "device", "medication", "substance"], "description": "person | animal | practitioner | device | medication | substance" }, "actual": { "type": "boolean", "description": "Descriptive or actual" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Kind of Group members" }, "name": { "type": "string", "description": "Label for Group" }, "quantity": { "type": "integer", "description": "Number of members" }, "managingEntity": { "$ref": "#/components/schemas/Reference", "description": "Entity that is the custodian of the Group's definition" }, "member": { "type": "array", "items": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/Reference", "description": "Reference to the group member" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Period member belonged to the group" }, "inactive": { "type": "boolean", "description": "If member is no longer in group" } }, "required": ["entity"] }, "description": "Who or what is in group" } }, "required": ["type", "actual"] } ] }, "Organization": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Identifies this organization across multiple systems" }, "active": { "type": "boolean", "description": "Whether the organization's record is still in active use" }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Kind of organization" }, "name": { "type": "string", "description": "Name used for the organization" }, "alias": { "type": "array", "items": { "type": "string" }, "description": "A list of alternate names that the organization is known as" }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPoint" }, "description": "A contact detail for the organization" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "An address for the organization" } } } ] }, "Practitioner": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "An identifier for the person as this agent" }, "active": { "type": "boolean", "description": "Whether this practitioner's record is in active use" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/HumanName" }, "description": "The name(s) associated with the practitioner" }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPoint" }, "description": "A contact detail for the practitioner" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "Address(es) of the practitioner" }, "gender": { "type": "string", "enum": ["male", "female", "other", "unknown"], "description": "male | female | other | unknown" }, "birthDate": { "type": "string", "format": "date", "description": "The date on which the practitioner was born" }, "qualification": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "An identifier for this qualification for the practitioner" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Coded representation of the qualification" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Period during which the qualification is valid" }, "issuer": { "$ref": "#/components/schemas/Reference", "description": "Organization that regulates and issues the qualification" } }, "required": ["code"] }, "description": "Certification, licenses, or training pertaining to the provision of care" } } } ] }, "PractitionerRole": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "An identifier for the person as this agent" }, "active": { "type": "boolean", "description": "Whether this practitioner's record is in active use" }, "name": { "type": "array", "items": { "$ref": "#/components/schemas/HumanName" }, "description": "The name(s) associated with the practitioner" }, "telecom": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPoint" }, "description": "A contact detail for the practitioner" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "Address(es) of the practitioner" }, "gender": { "type": "string", "enum": ["male", "female", "other", "unknown"], "description": "male | female | other | unknown" }, "birthDate": { "type": "string", "format": "date", "description": "The date on which the practitioner was born" }, "qualification": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "An identifier for this qualification for the practitioner" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Coded representation of the qualification" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Period during which the qualification is valid" }, "issuer": { "$ref": "#/components/schemas/Reference", "description": "Organization that regulates and issues the qualification" } }, "required": ["code"] }, "description": "Certification, licenses, or training pertaining to the provision of care" } } } ] }, "AllergyIntolerance": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External ids for this item" }, "clinicalStatus": { "$ref": "#/components/schemas/CodeableConcept", "description": "active | inactive | resolved" }, "verificationStatus": { "$ref": "#/components/schemas/CodeableConcept", "description": "unconfirmed | confirmed | refuted | entered-in-error" }, "type": { "type": "string", "enum": ["allergy", "intolerance"], "description": "allergy | intolerance - Underlying mechanism (if known)" }, "category": { "type": "array", "items": { "type": "string", "enum": ["food", "medication", "environment", "biologic"] }, "description": "food | medication | environment | biologic" }, "criticality": { "type": "string", "enum": ["low", "high", "unable-to-assess"], "description": "low | high | unable-to-assess" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Code that identifies the allergy or intolerance" }, "patient": { "$ref": "#/components/schemas/Reference", "description": "Who the sensitivity is for" }, "onsetDateTime": { "type": "string", "format": "date-time", "description": "When allergy or intolerance was identified" }, "recordedDate": { "type": "string", "format": "date-time", "description": "Date first version of the resource instance was recorded" }, "recorder": { "$ref": "#/components/schemas/Reference", "description": "Who recorded the sensitivity" }, "asserter": { "$ref": "#/components/schemas/Reference", "description": "Source of the information about the allergy" }, "reaction": { "type": "array", "items": { "type": "object", "properties": { "substance": { "$ref": "#/components/schemas/CodeableConcept", "description": "Specific substance or pharmaceutical product considered to be responsible for event" }, "manifestation": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Clinical symptoms/signs associated with the Event" }, "description": { "type": "string", "description": "Description of the event as a whole" }, "onset": { "type": "string", "format": "date-time", "description": "Date(/time) when manifestations showed" }, "severity": { "type": "string", "enum": ["mild", "moderate", "severe"], "description": "mild | moderate | severe" } }, "required": ["manifestation"] }, "description": "Adverse Reaction Events linked to exposure to substance" } }, "required": ["patient"] } ] }, "Medication": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External identifier" }, "status": { "type": "string", "enum": ["preparation", "in-progress", "cancelled", "on-hold", "completed", "entered-in-error", "stopped", "declined", "unknown"], "description": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown" }, "medicationCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", "description": "What medication was supplied" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who the dispense is for" }, "performer": { "type": "array", "items": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/CodeableConcept", "description": "Who performed the dispense and what they did" }, "actor": { "$ref": "#/components/schemas/Reference", "description": "Individual who was performing" } }, "required": ["actor"] }, "description": "Who performed the dispense and what they did" }, "authorizingPrescription": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Medication order that authorized the dispense" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Trial fill, partial fill, emergency fill, etc." }, "quantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount dispensed" }, "daysSupply": { "$ref": "#/components/schemas/Quantity", "description": "Amount of medication expressed as a timing amount" }, "whenPrepared": { "type": "string", "format": "date-time", "description": "When product was packaged and reviewed" }, "whenHandedOver": { "type": "string", "format": "date-time", "description": "When product was given out" } }, "required": ["status"] } ] }, "MedicationDispense": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External identifier" }, "status": { "type": "string", "enum": ["preparation", "in-progress", "cancelled", "on-hold", "completed", "entered-in-error", "stopped", "declined", "unknown"], "description": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown" }, "medicationCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", "description": "What medication was supplied" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who the dispense is for" }, "performer": { "type": "array", "items": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/CodeableConcept", "description": "Who performed the dispense and what they did" }, "actor": { "$ref": "#/components/schemas/Reference", "description": "Individual who was performing" } }, "required": ["actor"] }, "description": "Who performed the dispense and what they did" }, "authorizingPrescription": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Medication order that authorized the dispense" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Trial fill, partial fill, emergency fill, etc." }, "quantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount dispensed" }, "daysSupply": { "$ref": "#/components/schemas/Quantity", "description": "Amount of medication expressed as a timing amount" }, "whenPrepared": { "type": "string", "format": "date-time", "description": "When product was packaged and reviewed" }, "whenHandedOver": { "type": "string", "format": "date-time", "description": "When product was given out" } }, "required": ["status"] } ] }, "DocumentReference": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Other identifiers for the document" }, "status": { "type": "string", "enum": ["current", "superseded", "entered-in-error"], "description": "current | superseded | entered-in-error" }, "docStatus": { "type": "string", "enum": ["preliminary", "final", "amended", "entered-in-error"], "description": "preliminary | final | amended | entered-in-error" }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Kind of document (LOINC if possible)" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Categorization of document" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who/what is the subject of the document" }, "date": { "type": "string", "format": "date-time", "description": "When this document reference was created" }, "author": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Who and/or what authored the document" }, "authenticator": { "$ref": "#/components/schemas/Reference", "description": "Who/what authenticated the document" }, "custodian": { "$ref": "#/components/schemas/Reference", "description": "Organization which maintains the document" }, "content": { "type": "array", "items": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "contentType": { "type": "string", "description": "Mime type of the content, with charset etc." }, "language": { "type": "string", "description": "Human language of the content (BCP-47)" }, "data": { "type": "string", "format": "byte", "description": "Data inline, base64ed" }, "url": { "type": "string", "format": "uri", "description": "Uri where the data can be found" }, "size": { "type": "integer", "description": "Number of bytes of content (if url provided)" }, "hash": { "type": "string", "format": "byte", "description": "Hash of the data (sha-1, base64ed)" }, "title": { "type": "string", "description": "Label to display in place of the data" }, "creation": { "type": "string", "format": "date-time", "description": "Date attachment was first created" } }, "description": "Where to access the document" }, "format": { "$ref": "#/components/schemas/Coding", "description": "Format/content rules for the document" } }, "required": ["attachment"] }, "description": "Document referenced" } }, "required": ["status", "content"] } ] }, "Procedure": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External Identifiers for this procedure" }, "status": { "type": "string", "enum": ["preparation", "in-progress", "not-done", "on-hold", "stopped", "completed", "entered-in-error", "unknown"], "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown" }, "category": { "$ref": "#/components/schemas/CodeableConcept", "description": "Classification of the procedure" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Identification of the procedure" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who the procedure was performed on" }, "performedDateTime": { "type": "string", "format": "date-time", "description": "When the procedure was performed" }, "performer": { "type": "array", "items": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/CodeableConcept", "description": "Type of performance" }, "actor": { "$ref": "#/components/schemas/Reference", "description": "The reference to the practitioner" } }, "required": ["actor"] }, "description": "The people who performed the procedure" }, "location": { "$ref": "#/components/schemas/Reference", "description": "Where the procedure happened" }, "reasonCode": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Coded reason procedure performed" }, "bodySite": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Target body sites" } }, "required": ["status", "subject"] } ] }, "Immunization": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Business identifier" }, "status": { "type": "string", "enum": ["completed", "entered-in-error", "not-done"], "description": "completed | entered-in-error | not-done" }, "vaccineCode": { "$ref": "#/components/schemas/CodeableConcept", "description": "Vaccine product administered" }, "patient": { "$ref": "#/components/schemas/Reference", "description": "Who was immunized" }, "occurrenceDateTime": { "type": "string", "format": "date-time", "description": "Vaccine administration date" }, "recorded": { "type": "string", "format": "date-time", "description": "When the immunization was first captured in the subject's record" }, "primarySource": { "type": "boolean", "description": "Indicates context the data was recorded in" }, "location": { "$ref": "#/components/schemas/Reference", "description": "Where immunization occurred" }, "manufacturer": { "$ref": "#/components/schemas/Reference", "description": "Vaccine manufacturer" }, "lotNumber": { "type": "string", "description": "Vaccine lot number" }, "expirationDate": { "type": "string", "format": "date", "description": "Vaccine expiration date" }, "site": { "$ref": "#/components/schemas/CodeableConcept", "description": "Body site vaccine was administered" }, "route": { "$ref": "#/components/schemas/CodeableConcept", "description": "How vaccine entered body" }, "doseQuantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount of vaccine administered" }, "performer": { "type": "array", "items": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/CodeableConcept", "description": "What type of performance was done" }, "actor": { "$ref": "#/components/schemas/Reference", "description": "Individual or organization who was performing" } }, "required": ["actor"] }, "description": "Who performed the immunization event" } }, "required": ["status", "vaccineCode", "patient", "occurrenceDateTime"] } ] }, "ImmunizationRecommendation": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Business identifier" }, "status": { "type": "string", "enum": ["completed", "entered-in-error", "not-done"], "description": "completed | entered-in-error | not-done" }, "vaccineCode": { "$ref": "#/components/schemas/CodeableConcept", "description": "Vaccine product administered" }, "patient": { "$ref": "#/components/schemas/Reference", "description": "Who was immunized" }, "occurrenceDateTime": { "type": "string", "format": "date-time", "description": "Vaccine administration date" }, "recorded": { "type": "string", "format": "date-time", "description": "When the immunization was first captured in the subject's record" }, "primarySource": { "type": "boolean", "description": "Indicates context the data was recorded in" }, "location": { "$ref": "#/components/schemas/Reference", "description": "Where immunization occurred" }, "manufacturer": { "$ref": "#/components/schemas/Reference", "description": "Vaccine manufacturer" }, "lotNumber": { "type": "string", "description": "Vaccine lot number" }, "expirationDate": { "type": "string", "format": "date", "description": "Vaccine expiration date" }, "site": { "$ref": "#/components/schemas/CodeableConcept", "description": "Body site vaccine was administered" }, "route": { "$ref": "#/components/schemas/CodeableConcept", "description": "How vaccine entered body" }, "doseQuantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount of vaccine administered" }, "performer": { "type": "array", "items": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/CodeableConcept", "description": "What type of performance was done" }, "actor": { "$ref": "#/components/schemas/Reference", "description": "Individual or organization who was performing" } }, "required": ["actor"] }, "description": "Who performed the immunization event" } }, "required": ["status", "vaccineCode", "patient", "occurrenceDateTime"] } ] }, "ImmunizationEvaluation": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Business identifier" }, "status": { "type": "string", "enum": ["completed", "entered-in-error", "not-done"], "description": "completed | entered-in-error | not-done" }, "vaccineCode": { "$ref": "#/components/schemas/CodeableConcept", "description": "Vaccine product administered" }, "patient": { "$ref": "#/components/schemas/Reference", "description": "Who was immunized" }, "occurrenceDateTime": { "type": "string", "format": "date-time", "description": "Vaccine administration date" }, "recorded": { "type": "string", "format": "date-time", "description": "When the immunization was first captured in the subject's record" }, "primarySource": { "type": "boolean", "description": "Indicates context the data was recorded in" }, "location": { "$ref": "#/components/schemas/Reference", "description": "Where immunization occurred" }, "manufacturer": { "$ref": "#/components/schemas/Reference", "description": "Vaccine manufacturer" }, "lotNumber": { "type": "string", "description": "Vaccine lot number" }, "expirationDate": { "type": "string", "format": "date", "description": "Vaccine expiration date" }, "site": { "$ref": "#/components/schemas/CodeableConcept", "description": "Body site vaccine was administered" }, "route": { "$ref": "#/components/schemas/CodeableConcept", "description": "How vaccine entered body" }, "doseQuantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount of vaccine administered" }, "performer": { "type": "array", "items": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/CodeableConcept", "description": "What type of performance was done" }, "actor": { "$ref": "#/components/schemas/Reference", "description": "Individual or organization who was performing" } }, "required": ["actor"] }, "description": "Who performed the immunization event" } }, "required": ["status", "vaccineCode", "patient", "occurrenceDateTime"] } ] }, "Condition": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External Ids for this condition" }, "clinicalStatus": { "$ref": "#/components/schemas/CodeableConcept", "description": "active | recurrence | relapse | inactive | remission | resolved" }, "verificationStatus": { "$ref": "#/components/schemas/CodeableConcept", "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "problem-list-item | encounter-diagnosis" }, "severity": { "$ref": "#/components/schemas/CodeableConcept", "description": "Subjective severity of condition" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Identification of the condition, problem or diagnosis" }, "bodySite": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Anatomical location, if relevant" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who has the condition?" }, "encounter": { "$ref": "#/components/schemas/Reference", "description": "Encounter created as part of" }, "onsetDateTime": { "type": "string", "format": "date-time", "description": "Estimated or actual date, date-time, or age" }, "abatementDateTime": { "type": "string", "format": "date-time", "description": "When in resolution/remission" }, "recordedDate": { "type": "string", "format": "date-time", "description": "Date record was first recorded" }, "recorder": { "$ref": "#/components/schemas/Reference", "description": "Who recorded the condition" }, "asserter": { "$ref": "#/components/schemas/Reference", "description": "Person who asserts this condition" } }, "required": ["subject"] } ] }, "Encounter": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Identifier(s) by which this encounter is known" }, "status": { "type": "string", "enum": ["planned", "arrived", "triaged", "in-progress", "onleave", "finished", "cancelled", "entered-in-error", "unknown"], "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown" }, "class": { "$ref": "#/components/schemas/Coding", "description": "Classification of patient encounter" }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Specific type of encounter" }, "serviceType": { "$ref": "#/components/schemas/CodeableConcept", "description": "Specific type of service" }, "priority": { "$ref": "#/components/schemas/CodeableConcept", "description": "Indicates the urgency of the encounter" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "The patient or group present at the encounter" }, "participant": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Role of participant in encounter" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Period of time during the encounter that the participant participated" }, "individual": { "$ref": "#/components/schemas/Reference", "description": "Persons involved in the encounter other than the patient" } } }, "description": "List of participants involved in the encounter" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "The start and end time of the encounter" }, "reasonCode": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Coded reason the encounter takes place" }, "hospitalization": { "type": "object", "properties": { "preAdmissionIdentifier": { "$ref": "#/components/schemas/Identifier", "description": "Pre-admission identifier" }, "origin": { "$ref": "#/components/schemas/Reference", "description": "The location/organization from which the patient came before admission" }, "admitSource": { "$ref": "#/components/schemas/CodeableConcept", "description": "From where patient was admitted (physician referral, transfer)" }, "reAdmission": { "$ref": "#/components/schemas/CodeableConcept", "description": "The type of hospital re-admission that has occurred" }, "dischargeDisposition": { "$ref": "#/components/schemas/CodeableConcept", "description": "Category or kind of location after discharge" }, "destination": { "$ref": "#/components/schemas/Reference", "description": "Location/organization to which the patient is discharged" } }, "description": "Details about the admission to a healthcare service" }, "location": { "type": "array", "items": { "type": "object", "properties": { "location": { "$ref": "#/components/schemas/Reference", "description": "Location the encounter takes place" }, "status": { "type": "string", "enum": ["planned", "active", "reserved", "completed"], "description": "planned | active | reserved | completed" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Starting time with inclusive boundary" }, "end": { "type": "string", "format": "date-time", "description": "End time with inclusive boundary, if not ongoing" } }, "description": "Time period during which the patient was present at the location" } }, "required": ["location"] }, "description": "List of locations where the patient has been" }, "serviceProvider": { "$ref": "#/components/schemas/Reference", "description": "The organization (facility) responsible for this encounter" } }, "required": ["status", "class", "subject"] } ] }, "DiagnosticReport": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "Business identifier for report" }, "status": { "type": "string", "enum": ["registered", "partial", "preliminary", "final", "amended", "corrected", "appended", "cancelled", "entered-in-error", "unknown"], "description": "registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Service category" }, "code": { "$ref": "#/components/schemas/CodeableConcept", "description": "Name/Code for this diagnostic report" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "The subject of the report - usually, but not always, the patient" }, "encounter": { "$ref": "#/components/schemas/Reference", "description": "Health care event when test ordered" }, "effectiveDateTime": { "type": "string", "format": "date-time", "description": "Clinically relevant time/time-period for report" }, "issued": { "type": "string", "format": "date-time", "description": "DateTime this version was made" }, "performer": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Responsible Diagnostic Service" }, "resultsInterpreter": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Primary result interpreter" }, "specimen": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Specimens this report is based on" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Observations" }, "imagingStudy": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "description": "Reference to full details of imaging associated with the diagnostic report" }, "media": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string", "description": "Comment about the image (e.g. explanation)" }, "link": { "$ref": "#/components/schemas/Reference", "description": "Reference to the image source" } }, "required": ["link"] }, "description": "Key images associated with this report" }, "conclusion": { "type": "string", "description": "Clinical conclusion (interpretation) of test results" }, "conclusionCode": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Codes for the clinical conclusion of test results" } }, "required": ["status", "code", "subject"] } ] }, "MedicationRequest": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External ids for this request" }, "status": { "type": "string", "enum": ["active", "on-hold", "cancelled", "completed", "entered-in-error", "stopped", "draft", "unknown"], "description": "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown" }, "intent": { "type": "string", "enum": ["proposal", "plan", "order", "original-order", "reflex-order", "filler-order", "instance-order", "option"], "description": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Type of medication usage" }, "priority": { "type": "string", "enum": ["routine", "urgent", "asap", "stat"], "description": "routine | urgent | asap | stat" }, "medicationCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", "description": "Medication to be taken" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who or group medication request is for" }, "encounter": { "$ref": "#/components/schemas/Reference", "description": "Encounter created as part of encounter/admission/stay" }, "authoredOn": { "type": "string", "format": "date-time", "description": "When request was initially authored" }, "requester": { "$ref": "#/components/schemas/Reference", "description": "Who/What requested the Request" }, "reasonCode": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Reason or indication for ordering or not ordering the medication" }, "dosageInstruction": { "type": "array", "items": { "type": "object", "properties": { "sequence": { "type": "integer", "description": "The order of the dosage instructions" }, "text": { "type": "string", "description": "Free text dosage instructions e.g. SIG" }, "timing": { "type": "object", "properties": { "repeat": { "type": "object", "properties": { "frequency": { "type": "integer", "description": "Event occurs frequency times per period" }, "period": { "type": "number", "description": "Event occurs frequency times per period" }, "periodUnit": { "type": "string", "enum": ["s", "min", "h", "d", "wk", "mo", "a"], "description": "s | min | h | d | wk | mo | a - unit of time (UCUM)" } } } }, "description": "When medication should be administered" }, "route": { "$ref": "#/components/schemas/CodeableConcept", "description": "How drug should enter body" }, "doseAndRate": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "The kind of dose or rate specified" }, "doseQuantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount of medication per dose" } } }, "description": "Amount of medication administered" } } }, "description": "How the medication is to be used by the patient or administered by the caregiver" }, "dispenseRequest": { "type": "object", "properties": { "quantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount to be dispensed in total" }, "numberOfRepeatsAllowed": { "type": "integer", "description": "Number of refills authorized" }, "expectedSupplyDuration": { "$ref": "#/components/schemas/Quantity", "description": "Number of days supply per dispense" } }, "description": "Medication supply authorization" } }, "required": ["status", "intent", "subject"] } ] }, "Provenance": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "properties": { "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/Identifier" }, "description": "External ids for this request" }, "status": { "type": "string", "enum": ["active", "on-hold", "cancelled", "completed", "entered-in-error", "stopped", "draft", "unknown"], "description": "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown" }, "intent": { "type": "string", "enum": ["proposal", "plan", "order", "original-order", "reflex-order", "filler-order", "instance-order", "option"], "description": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option" }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Type of medication usage" }, "priority": { "type": "string", "enum": ["routine", "urgent", "asap", "stat"], "description": "routine | urgent | asap | stat" }, "medicationCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", "description": "Medication to be taken" }, "subject": { "$ref": "#/components/schemas/Reference", "description": "Who or group medication request is for" }, "encounter": { "$ref": "#/components/schemas/Reference", "description": "Encounter created as part of encounter/admission/stay" }, "authoredOn": { "type": "string", "format": "date-time", "description": "When request was initially authored" }, "requester": { "$ref": "#/components/schemas/Reference", "description": "Who/What requested the Request" }, "reasonCode": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept" }, "description": "Reason or indication for ordering or not ordering the medication" }, "dosageInstruction": { "type": "array", "items": { "type": "object", "properties": { "sequence": { "type": "integer", "description": "The order of the dosage instructions" }, "text": { "type": "string", "description": "Free text dosage instructions e.g. SIG" }, "timing": { "type": "object", "properties": { "repeat": { "type": "object", "properties": { "frequency": { "type": "integer", "description": "Event occurs frequency times per period" }, "period": { "type": "number", "description": "Event occurs frequency times per period" }, "periodUnit": { "type": "string", "enum": ["s", "min", "h", "d", "wk", "mo", "a"], "description": "s | min | h | d | wk | mo | a - unit of time (UCUM)" } } } }, "description": "When medication should be administered" }, "route": { "$ref": "#/components/schemas/CodeableConcept", "description": "How drug should enter body" }, "doseAndRate": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "The kind of dose or rate specified" }, "doseQuantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount of medication per dose" } } }, "description": "Amount of medication administered" } } }, "description": "How the medication is to be used by the patient or administered by the caregiver" }, "dispenseRequest": { "type": "object", "properties": { "quantity": { "$ref": "#/components/schemas/Quantity", "description": "Amount to be dispensed in total" }, "numberOfRepeatsAllowed": { "type": "integer", "description": "Number of refills authorized" }, "expectedSupplyDuration": { "$ref": "#/components/schemas/Quantity", "description": "Number of days supply per dispense" } }, "description": "Medication supply authorization" } }, "required": ["status", "intent", "subject"] } ] } } }, "tags": [ { "name": "System", "description": "System-level operations and capabilities" }, { "name": "Patient", "description": "Patient resource operations - Demographics and other administrative information about an individual (45 records)" }, { "name": "Observation", "description": "Observation resource operations - Measurements and simple assertions made about a patient (453 records)" }, { "name": "Medication", "description": "Medication-related resources - Prescriptions, administrations, and dispensing (42 medication requests, 47 dispenses)" }, { "name": "Encounter", "description": "Encounter resource operations - An interaction between a patient and healthcare provider(s) (71 records)" }, { "name": "Provenance", "description": "Provenance resource operations - Who did what, when, and why (907 records)" }, { "name": "Binary", "description": "Binary resource operations - Raw binary data (423 records)" } ] }