{ "openapi": "3.0.2", "info": { "title": "Specialty Rx CapabilityStatement - Data Source - Messaging", "description": "This CapabilityStatement describes the expected capabilities of a server that is capable of providing patient information using Specialty Rx Query messaging.", "license": { "name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html" }, "version": "0.1.0", "contact": { "name": "HL7 International - Pharmacy", "url": "http://www.hl7.org/Special/committees/medication" } }, "externalDocs": { "url": "http://hl7.org/fhir/us/specialty-rx/CapabilityStatement/specialty-rx-data-source-messaging", "description": "FHIR CapabilityStatement" }, "paths": { "/metadata": { "summary": "Access to the Server\u0027s Capability Statement", "description": "All FHIR Servers return a CapabilityStatement that describes what services they perform", "get": { "summary": "Return the server\u0027s capability statement", "operationId": "metadata", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the capbility statement", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CapabilityStatement" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/CapabilityStatement.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" } ] } }, "/AllergyIntolerance": { "summary": "manage the collection of resources of type AllergyIntolerance", "description": "Access to services to manage the collection of all resources of type AllergyIntolerance", "get": { "summary": "Search all resources of type AllergyIntolerance based on a set of criteria", "operationId": "searchAllergyIntolerance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "clinical-status", "in": "query", "schema": { "type": "string" }, "description": "active | inactive | resolved\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "patient", "in": "query", "schema": { "type": "string" }, "description": "Who the sensitivity is for\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " } ] } }, "/AllergyIntolerance/{rid}": { "summary": "Read/Write/etc resource instance of type AllergyIntolerance", "description": "Access to services to manage the state of a single resource of type AllergyIntolerance", "get": { "summary": "Read the current state of the resource", "operationId": "readAllergyIntolerance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/AllergyIntolerance.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Condition": { "summary": "manage the collection of resources of type Condition", "description": "Access to services to manage the collection of all resources of type Condition", "get": { "summary": "Search all resources of type Condition based on a set of criteria", "operationId": "searchCondition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "The category of the condition\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "clinical-status", "in": "query", "schema": { "type": "string" }, "description": "The clinical status of the condition\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "patient", "in": "query", "schema": { "type": "string" }, "description": "Who has the condition?\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "onset-date", "in": "query", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" }, "description": "Date related onsets (dateTime and Period)\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "code", "in": "query", "schema": { "type": "string" }, "description": "Code for the condition\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " } ] } }, "/Condition/{rid}": { "summary": "Read/Write/etc resource instance of type Condition", "description": "Access to services to manage the state of a single resource of type Condition", "get": { "summary": "Read the current state of the resource", "operationId": "readCondition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Condition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Condition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Coverage": { "summary": "manage the collection of resources of type Coverage", "description": "Access to services to manage the collection of all resources of type Coverage", "get": { "summary": "Search all resources of type Coverage based on a set of criteria", "operationId": "searchCoverage", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "schema": { "type": "string" }, "description": "Retrieve coverages for a patient" }, { "name": "beneficiary", "in": "query", "schema": { "type": "string" }, "description": "Covered party" } ] } }, "/Coverage/{rid}": { "summary": "Read/Write/etc resource instance of type Coverage", "description": "Access to services to manage the state of a single resource of type Coverage", "get": { "summary": "Read the current state of the resource", "operationId": "readCoverage", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Coverage" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Coverage.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/MedicationRequest": { "summary": "manage the collection of resources of type MedicationRequest", "description": "Access to services to manage the collection of all resources of type MedicationRequest", "get": { "summary": "Search all resources of type MedicationRequest based on a set of criteria", "operationId": "searchMedicationRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Status of the prescription\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "intent", "in": "query", "schema": { "type": "string" }, "description": "Returns prescriptions with different intents\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "patient", "in": "query", "schema": { "type": "string" }, "description": "Returns prescriptions for a specific patient\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "encounter", "in": "query", "schema": { "type": "string" }, "description": "Return prescriptions with this encounter identifier\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "authoredon", "in": "query", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" }, "description": "Return prescriptions written on this date\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " } ] } }, "/MedicationRequest/{rid}": { "summary": "Read/Write/etc resource instance of type MedicationRequest", "description": "Access to services to manage the state of a single resource of type MedicationRequest", "get": { "summary": "Read the current state of the resource", "operationId": "readMedicationRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/MedicationRequest" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/MedicationRequest.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Observation": { "summary": "manage the collection of resources of type Observation", "description": "Access to services to manage the collection of all resources of type Observation", "get": { "summary": "Search all resources of type Observation based on a set of criteria", "operationId": "searchObservation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "The status of the observation\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "The classification of the type of observation\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "code", "in": "query", "schema": { "type": "string" }, "description": "The code of the observation type\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "date", "in": "query", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" }, "description": "Obtained date/time. If the obtained element is a period, a date that falls in the period\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " } ] } }, "/Observation/{rid}": { "summary": "Read/Write/etc resource instance of type Observation", "description": "Access to services to manage the state of a single resource of type Observation", "get": { "summary": "Read the current state of the resource", "operationId": "readObservation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Observation" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Observation.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/DocumentReference": { "summary": "manage the collection of resources of type DocumentReference", "description": "Access to services to manage the collection of all resources of type DocumentReference", "get": { "summary": "Search all resources of type DocumentReference based on a set of criteria", "operationId": "searchDocumentReference", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "schema": { "type": "string" }, "description": "Logical id of this artifact\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "current | superseded | entered-in-error\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "patient", "in": "query", "schema": { "type": "string" }, "description": "Who/what is the subject of the document\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "Categorization of document\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "Kind of document (LOINC if possible)\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "date", "in": "query", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" }, "description": "When this document reference was created\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " }, { "name": "period", "in": "query", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" }, "description": "Time of service that is being documented\u003cbr /\u003e\n\u003cem\u003eNOTE\u003c/em\u003e: This US Core SearchParameter definition extends the usage context of\n\u003ca href\u003d\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\"\u003ecapabilitystatement-expectation\u003c/a\u003e\n extension to formally express implementer expectations for these elements:\u003cbr /\u003e\n - multipleAnd\u003cbr /\u003e\n - multipleOr\u003cbr /\u003e\n - modifier\u003cbr /\u003e\n - comparator\u003cbr /\u003e\n - chain\u003cbr /\u003e\n " } ] } }, "/DocumentReference/{rid}": { "summary": "Read/Write/etc resource instance of type DocumentReference", "description": "Access to services to manage the state of a single resource of type DocumentReference", "get": { "summary": "Read the current state of the resource", "operationId": "readDocumentReference", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DocumentReference.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/OperationOutcome/{rid}": { "summary": "Read/Write/etc resource instance of type OperationOutcome", "description": "Access to services to manage the state of a single resource of type OperationOutcome", "get": { "summary": "Read the current state of the resource", "operationId": "readOperationOutcome", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/OperationOutcome": { "summary": "Manager for resources of type OperationOutcome", "description": "The Manager for resources of type OperationOutcome: provides services to manage the collection of all the OperationOutcome instances", "post": { "summary": "Create a new resource", "operationId": "createOperationOutcome", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned after being updated", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Task/{rid}": { "summary": "Read/Write/etc resource instance of type Task", "description": "Access to services to manage the state of a single resource of type Task", "get": { "summary": "Read the current state of the resource", "operationId": "readTask", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateTask", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned after being updated", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Task": { "summary": "Manager for resources of type Task", "description": "The Manager for resources of type Task: provides services to manage the collection of all the Task instances", "post": { "summary": "Create a new resource", "operationId": "createTask", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "200": { "description": "the resource being returned after being updated", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } } }, "components": { "parameters": { "rid": { "name": "rid", "in": "path", "description": "id of the resource (\u003dResource.id)", "required": true, "allowEmptyValue": false, "style": "simple", "schema": { "type": "string" } }, "hid": { "name": "hid", "in": "path", "description": "id of the history entry (\u003dResource.meta.versionId)", "required": true, "allowEmptyValue": false, "style": "simple", "schema": { "type": "string" } }, "summary": { "name": "_summary", "in": "query", "description": "Requests the server to return a designated subset of the resource", "allowEmptyValue": true, "style": "form", "schema": { "type": "string", "enum": [ "true", "text", "data", "count", "false" ] } }, "format": { "name": "_format", "in": "query", "description": "Specify alternative response formats by their MIME-types (when a client is unable acccess accept: header)", "allowEmptyValue": true, "style": "form", "schema": { "type": "string", "format": "mime-type" } }, "pretty": { "name": "_pretty", "in": "query", "description": "Ask for a pretty printed response for human convenience", "allowEmptyValue": true, "style": "form", "schema": { "type": "boolean" } }, "elements": { "name": "_elements", "in": "query", "description": "Requests the server to return a collection of elements from the resource", "allowEmptyValue": true, "style": "form", "explode": false, "schema": { "type": "array", "format": "string", "items": { "format": "string" } } }, "count": { "name": "_count", "in": "query", "description": "The maximum number of search results on a page. The server is not bound to return the number requested, but cannot return more", "schema": { "type": "number" } } } } }