{ "openapi": "3.0.2", "info": { "title": "plan", "license": { "name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html" }, "version": "8.0.1", "contact": { "name": "Den telemedicinske infrastruktur (eHealth Infrastructure)", "url": "http://ehealth.sundhed.dk" } }, "servers": [ { "url": "https://plan.devtest.systematic-ehealth.com/fhir", "description": "eHealth plan service" } ], "externalDocs": { "url": "http://ehealth.sundhed.dk/fhir/CapabilityStatement/plan", "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" } ] } }, "/ActivityDefinition": { "summary": "Manager for resources of type ActivityDefinition", "description": "The Manager for resources of type ActivityDefinition: provides services to manage the collection of all the ActivityDefinition instances", "get": { "summary": "Search all resources of type ActivityDefinition based on a set of criteria", "operationId": "searchActivityDefinition", "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": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "The ID of the resource", "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "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)))?)?)?" } }, { "name": "_profile", "in": "query", "description": "Search for resources which have the given profile", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Search for resources which have the given security labels", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Search for resources which have the given source value (Resource.meta.source)", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Search for resources which have the given tag", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "base", "in": "query", "description": "Base of resource", "schema": { "type": "string" } }, { "name": "baseEnvironment", "in": "query", "description": "Base Environment of resource", "schema": { "type": "string" } }, { "name": "composed-of", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "A use context assigned to the activity definition", "schema": { "type": "string" } }, { "name": "context-quantity", "in": "query", "description": "A quantity- or range-valued use context assigned to the activity definition", "schema": { "type": "string" } }, { "name": "context-type", "in": "query", "description": "A type of use context assigned to the activity definition", "schema": { "type": "string" } }, { "name": "context-type-value", "in": "query", "description": "A use context type and value assigned to the activity definition", "schema": {} }, { "name": "date", "in": "query", "description": "The activity definition publication date", "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)))?)?)?" } }, { "name": "depends-on", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "derived-from", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the activity definition", "schema": { "type": "string" } }, { "name": "effective", "in": "query", "description": "The time during which the activity definition is intended to be in use", "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)))?)?)?" } }, { "name": "ehealthPredecessor", "in": "query", "description": "Predecessor of resource", "schema": { "type": "string" } }, { "name": "employeeTitle", "in": "query", "description": "Title intented for clinicians", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "External identifier for the activity definition", "schema": { "type": "string" } }, { "name": "intendedAudience", "in": "query", "description": "The intended audience of the plan definition", "schema": { "type": "string" } }, { "name": "jurisdiction", "in": "query", "description": "Intended jurisdiction for the activity definition", "schema": { "type": "string" } }, { "name": "modifier_role_reference", "in": "query", "description": "Reference to either Organization, CareTeam, Practitioner", "schema": { "type": "string" } }, { "name": "modifier_role_role", "in": "query", "description": "Role of Organization, CareTeam, Practitioner", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Computationally friendly name of the activity definition", "schema": { "type": "string" } }, { "name": "predecessor", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "description": "Name of the publisher of the activity definition", "schema": { "type": "string" } }, { "name": "recommendation", "in": "query", "description": "Recommendation for the plan definition", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The current status of the activity definition", "schema": { "type": "string" } }, { "name": "successor", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "The human-friendly name of the activity definition", "schema": { "type": "string" } }, { "name": "topic", "in": "query", "description": "Topics associated with the module", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "The uri that identifies the activity definition", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The business version of the activity definition", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createActivityDefinition", "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/ActivityDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ActivityDefinition.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/ActivityDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ActivityDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ActivityDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type ActivityDefinition", "description": "Access to services to manage the state of a single resource of type ActivityDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readActivityDefinition", "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/ActivityDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ActivityDefinition.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": "updateActivityDefinition", "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/ActivityDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ActivityDefinition.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/ActivityDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ActivityDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ActivityDefinition/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type ActivityDefinition", "description": "Access a to specified previous version of a single resource of type ActivityDefinition", "get": { "summary": "Read a past state of the resource", "operationId": "vreadActivityDefinition", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/ActivityDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ActivityDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Binary/{rid}": { "summary": "Read/Write/etc resource instance of type Binary", "description": "Access to services to manage the state of a single resource of type Binary", "get": { "summary": "Read the current state of the resource", "operationId": "readBinary", "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/Binary" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Binary/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Binary", "description": "Access a to specified previous version of a single resource of type Binary", "get": { "summary": "Read a past state of the resource", "operationId": "vreadBinary", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Binary" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/DocumentReference": { "summary": "Manager for resources of type DocumentReference", "description": "The Manager for resources of type DocumentReference: provides services to manage the collection of all the DocumentReference instances", "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": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "The ID of the resource", "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "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)))?)?)?" } }, { "name": "_profile", "in": "query", "description": "Search for resources which have the given profile", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Search for resources which have the given security labels", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Search for resources which have the given source value (Resource.meta.source)", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Search for resources which have the given tag", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "authenticator", "in": "query", "description": "Who/what authenticated the document", "schema": { "type": "string" } }, { "name": "author", "in": "query", "description": "Who and/or what authored the document", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Categorization of document", "schema": { "type": "string" } }, { "name": "contenttype", "in": "query", "description": "Mime type of the content, with charset etc.", "schema": { "type": "string" } }, { "name": "custodian", "in": "query", "description": "Organization which maintains the document", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "When this document reference was created", "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)))?)?)?" } }, { "name": "description", "in": "query", "description": "Human-readable description", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Context of the document content", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Main clinical acts documented", "schema": { "type": "string" } }, { "name": "facility", "in": "query", "description": "Kind of facility where patient was seen", "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Format/content rules for the document", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Master Version Specific Identifier", "schema": { "type": "string" } }, { "name": "intendedOrganization", "in": "query", "description": "The Organization which is intended to use the DocumentReference", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Human language of the content (BCP-47)", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Uri where the data can be found", "schema": { "type": "string" } }, { "name": "modifier_role_reference", "in": "query", "description": "Reference to modifier Organization", "schema": { "type": "string" } }, { "name": "modifier_role_role", "in": "query", "description": "Role of Organization related to modification of the DocumentReference", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Who/what is the subject of the document", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Time of service that is being documented", "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)))?)?)?" } }, { "name": "related", "in": "query", "description": "Related identifiers or resources", "schema": { "type": "string" } }, { "name": "relatesto", "in": "query", "description": "Target of the relationship", "schema": { "type": "string" } }, { "name": "relation", "in": "query", "description": "replaces | transforms | signs | appends", "schema": { "type": "string" } }, { "name": "relationship", "in": "query", "description": "Combination of relation and relatesTo", "schema": {} }, { "name": "security-label", "in": "query", "description": "Document security-tags", "schema": { "type": "string" } }, { "name": "setting", "in": "query", "description": "Additional details about where the content was created (e.g. clinical specialty)", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "current | superseded | entered-in-error", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who/what is the subject of the document", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Kind of document (LOINC if possible)", "schema": { "type": "string" } }, { "name": "use-context-context", "in": "query", "description": "A use context assigned to the DocumentReference", "schema": { "type": "string" } }, { "name": "use-context-context-type", "in": "query", "description": "A type of use context assigned to the DocumentReference", "schema": { "type": "string" } }, { "name": "use-context-context-type-value", "in": "query", "description": "A use context type and value assigned to the DocumentReference", "schema": {} } ] }, "post": { "summary": "Create a new resource", "operationId": "createDocumentReference", "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/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DocumentReference.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/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DocumentReference.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateDocumentReference", "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/DocumentReference" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DocumentReference.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/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" } ] } }, "/DocumentReference/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type DocumentReference", "description": "Access a to specified previous version of a single resource of type DocumentReference", "get": { "summary": "Read a past state of the resource", "operationId": "vreadDocumentReference", "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 for that version", "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/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/OperationDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type OperationDefinition", "description": "Access to services to manage the state of a single resource of type OperationDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readOperationDefinition", "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/OperationDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PlanDefinition": { "summary": "Manager for resources of type PlanDefinition", "description": "The Manager for resources of type PlanDefinition: provides services to manage the collection of all the PlanDefinition instances", "get": { "summary": "Search all resources of type PlanDefinition based on a set of criteria", "operationId": "searchPlanDefinition", "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": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "The ID of the resource", "schema": { "type": "string" } }, { "name": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "Only return resources which were last updated as specified by the given range", "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)))?)?)?" } }, { "name": "_profile", "in": "query", "description": "Search for resources which have the given profile", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Search for resources which have the given security labels", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Search for resources which have the given source value (Resource.meta.source)", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Search for resources which have the given tag", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "base", "in": "query", "description": "Base of resource", "schema": { "type": "string" } }, { "name": "baseEnvironment", "in": "query", "description": "Base Environment of resource", "schema": { "type": "string" } }, { "name": "composed-of", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "A use context assigned to the plan definition", "schema": { "type": "string" } }, { "name": "context-quantity", "in": "query", "description": "A quantity- or range-valued use context assigned to the plan definition", "schema": { "type": "string" } }, { "name": "context-type", "in": "query", "description": "A type of use context assigned to the plan definition", "schema": { "type": "string" } }, { "name": "context-type-value", "in": "query", "description": "A use context type and value assigned to the plan definition", "schema": {} }, { "name": "date", "in": "query", "description": "The plan definition publication date", "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)))?)?)?" } }, { "name": "definition", "in": "query", "description": "Activity or plan definitions used by plan definition", "schema": { "type": "string" } }, { "name": "depends-on", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "derived-from", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the plan definition", "schema": { "type": "string" } }, { "name": "documentation", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "effective", "in": "query", "description": "The time during which the plan definition is intended to be in use", "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)))?)?)?" } }, { "name": "ehealthPredecessor", "in": "query", "description": "Predecessor of resource", "schema": { "type": "string" } }, { "name": "employeeTitle", "in": "query", "description": "Title intented for clinicians", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "External identifier for the plan definition", "schema": { "type": "string" } }, { "name": "intendedAudience", "in": "query", "description": "The intended audience of the plan definition", "schema": { "type": "string" } }, { "name": "jurisdiction", "in": "query", "description": "Intended jurisdiction for the plan definition", "schema": { "type": "string" } }, { "name": "modifier_role_reference", "in": "query", "description": "Reference to either Organization, CareTeam, Practitioner", "schema": { "type": "string" } }, { "name": "modifier_role_role", "in": "query", "description": "Role of Organization, CareTeam, Practitioner", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Computationally friendly name of the plan definition", "schema": { "type": "string" } }, { "name": "predecessor", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "description": "Name of the publisher of the plan definition", "schema": { "type": "string" } }, { "name": "recommendation", "in": "query", "description": "Recommendation for the plan definition", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The current status of the plan definition", "schema": { "type": "string" } }, { "name": "successor", "in": "query", "description": "What resource is being referenced", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "The human-friendly name of the plan definition", "schema": { "type": "string" } }, { "name": "topic", "in": "query", "description": "Topics associated with the module", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The type of artifact the plan (e.g. order-set, eca-rule, protocol)", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "The uri that identifies the plan definition", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The business version of the plan definition", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createPlanDefinition", "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/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.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/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PlanDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type PlanDefinition", "description": "Access to services to manage the state of a single resource of type PlanDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readPlanDefinition", "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/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.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": "updatePlanDefinition", "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/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.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/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PlanDefinition/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type PlanDefinition", "description": "Access a to specified previous version of a single resource of type PlanDefinition", "get": { "summary": "Read a past state of the resource", "operationId": "vreadPlanDefinition", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/PlanDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/PlanDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ActivityDefinition/$validate": { "summary": "Operation $validate on type ActivityDefinition", "description": "Operation $validate on type ActivityDefinition", "post": { "summary": "$validate on type ActivityDefinition", "operationId": "op-validate-ActivityDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/ActivityDefinition/$create-clone": { "summary": "Operation $create-clone on type ActivityDefinition", "description": "Operation $create-clone on type ActivityDefinition", "post": { "summary": "$create-clone on type ActivityDefinition", "description": "### Input\n- resourceId: reference to the ActivityDefinition resource that should be cloned\n- clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation \n- default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned \n- deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.\n\n### Output\nBundle containing all resources that were created during the operation.\n\n### Validation\n- New business versions require that the user has modifier-role: owner or co-author for the resource\n- New copy does not require that the user has a modifier-role.\n- New business version can be made only when no draft resource exists (having identical base identifier).\n- Read/search/create privileges are required for the resource types affected by $create-clone", "operationId": "op-create-clone-ActivityDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Binary/$expunge": { "summary": "Operation $expunge on type Binary", "description": "Operation $expunge on type Binary", "post": { "summary": "$expunge on type Binary", "operationId": "op-expunge-Binary", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/DocumentReference/$validate": { "summary": "Operation $validate on type DocumentReference", "description": "Operation $validate on type DocumentReference", "post": { "summary": "$validate on type DocumentReference", "operationId": "op-validate-DocumentReference", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/$validate": { "summary": "Operation $validate on type PlanDefinition", "description": "Operation $validate on type PlanDefinition", "post": { "summary": "$validate on type PlanDefinition", "operationId": "op-validate-PlanDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/$import": { "summary": "Operation $import on type PlanDefinition", "description": "Operation $import on type PlanDefinition", "post": { "summary": "$import on type PlanDefinition", "description": "Import a Plandefinition\n### Parameters\n- planDefinitionPackage: Binary package produced by the export operation\n### Output\nBundle containing the created resources. PlanDefinitions, ActivityDefinitions, and Questionnaires will be created. Imports QFFD DocumentReference into Document-Transformation service.Libraries and Organizations are used to find the corresponding resources on the target system.", "operationId": "op-import-PlanDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/$export": { "summary": "Operation $export on type PlanDefinition", "description": "Operation $export on type PlanDefinition", "post": { "summary": "$export on type PlanDefinition", "description": "Export a PlanDefinition.\n### Export Contents\nThe export contains the PlanDefinition including referenced resources:- PlanDefinitions\n- ActivityDefinitions\n- Questionnaires\n- Libraries\n- Organizations\n- DocumentReference + QFDD\n\nEach resource is returned in a separate JSon file.\n### Parameters\n- exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.\n### Output\nOutput can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.\nAll returned objects are Fhir resources. See the implementation guide for details", "operationId": "op-export-PlanDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/$create-clone": { "summary": "Operation $create-clone on type PlanDefinition", "description": "Operation $create-clone on type PlanDefinition", "post": { "summary": "$create-clone on type PlanDefinition", "description": "### Input\n- resourceId: reference to the PlanDefinition resource that should be cloned\n- clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation \n- default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned \n- deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.\n\n### Output\nBundle containing all resources that were created during the operation.\n\n### Validation\n- New business versions require that the user has modifier-role: owner or co-author for the resource\n- New copy does not require that the user has a modifier-role.\n- New business version can be made only when no draft resource exists (having identical base identifier).\n- Read/search/create privileges are required for the resource types affected by $create-clone", "operationId": "op-create-clone-PlanDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/PlanDefinition/$apply": { "summary": "Operation $apply on type PlanDefinition", "description": "Operation $apply on type PlanDefinition", "post": { "summary": "$apply on type PlanDefinition", "description": "Create a careplan with service requests for a specific episodeOfCare using the PlanDefinition as a template.\n### HTTP Methods\n- If using POST the operation will persist resources and return the careplan.\n- If using GET the operation will return transient resources in a transaction bundle. The bundle with transient careplan and servicerequest resources can then be modified before being persisted using a FHIR transaction.\n### Parameters\n- episodeOfCare: Reference(EpisodeOfCare) - The episode of care for which the plan is being applied.\n### Output\nCarePlan or Bundle of transient CarePlan and ServiceRequest resources.", "operationId": "op-apply-PlanDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$reindex": { "summary": "System level operation $reindex", "description": "Operation $reindex invoked at the system level", "post": { "summary": "$reindex (system)", "operationId": "op-reindex-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$hapi.fhir.reindex-status": { "summary": "System level operation $hapi.fhir.reindex-status", "description": "Operation $hapi.fhir.reindex-status invoked at the system level", "post": { "summary": "$hapi.fhir.reindex-status (system)", "operationId": "op-hapi.fhir.reindex-status-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$migrate": { "summary": "System level operation $migrate", "description": "Operation $migrate invoked at the system level", "post": { "summary": "$migrate (system)", "description": "Data migration", "operationId": "op-migrate-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$export-poll-status": { "summary": "System level operation $export-poll-status", "description": "Operation $export-poll-status invoked at the system level", "post": { "summary": "$export-poll-status (system)", "description": "Operation for polling the status of a previously initiated FHIR Bulk Data System Level Export. A complete URL including the \u0027_jobId\u0027 is returned in the \u0027Content-Location\u0027 response header when initiating the export. A \u0027GET\u0027 request to the polling location will return \u0027202 Accepted\u0027 with a response header \u0027X-Progress\u0027 containing a status message for the progress of the export job. When the job has finished, the polling location will return \u0027200 OK\u0027, and the contents of the body will be a JSON object providing metadata and links to the generated bulk data files. A \u0027DELETE\u0027 request can be used to cancel the export. If the export has already finished, the delete will return \u0027404 Not Found\u0027, else the export job will be cancelled and a \u0027202 Accepted\u0027 is returned with an operation outcome response.\n### Parameters\n- _jobId: the job ID for the Bulk Export job which was returned in the \u0027Content-Location\u0027 header when initiating the export", "operationId": "op-export-poll-status-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$export": { "summary": "System level operation $export", "description": "Operation $export invoked at the system level", "post": { "summary": "$export (system)", "description": "FHIR Operation to initiate an export of data from a FHIR server. The type of resources returned can be restricted using the \u0027_type\u0027 parameter, and the \u0027_since\u0027 parameter can be used to restrict resources to be only included if changed since the supplied time. The FHIR server support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html).\n## Initiation of export\nThe initiation of an export must specify the request header \u0027Prefer: respond-async\u0027, and will return \u0027202 Accepted\u0027 with a polling location in the response header \u0027Content-Location\u0027. The polling location is for the endpoint \u0027$export-poll-status\u0027 and has the export job ID as parameter \u0027_jobId\u0027.\n### Parameters\n- _outputFormat: Optional parameter to specify the output format of the exported files. Default is \u0027application/fhir+ndjson\u0027\n- _type: Optional parameter to specify a comma separated list of resource types to be included in the export. If not provided, all resource types will be included.\n- _since: Optional parameter to specify a time. Only resources that have been created or modified after this time will be included in the export (i.e., if Resource.meta.lastUpdated is later than the supplied _since time).\n- _until: Optional parameter to specify a time. Only resources that have been created or modified before this time will be included in the export (i.e., if Resource.meta.lastUpdated is earlier than the supplied _until time).\n- _typeFilter: Optional parameter to apply search filter of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied when searching resources.\n- _typePostFetchFilterUrl: Optional parameter to apply filtering of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied on resources after being fetched from the database.\n- _includeHistory: Optional parameter to specify whether historical versions of resources should be included in the export. Default is false.\n- _exportId: Optional parameter to specify a client provided identifier for the export. Resulting exported files (Binary) will be labeled with the identifer in meta extension \u0027https://hapifhir.org/NamingSystem/bulk-export-identifier\u0027\n## Polling status of export\nSubsequent GET requests to the polling location will return \u0027202 Accepted\u0027 with a response header \u0027X-Progress\u0027 containing a status message for the progress of the export job. When the job has finished, the polling location will return \u0027200 OK\u0027, and the contents of the body will be a JSON object providing metadata and links to the generated bulk export data files.\n## Retrieving exported files\nThe JSON object returned when the export job is complete will contain a list of files (Binary resources) available for download. Each file can be retrieved using a standard HTTP GET request to the provided URL. The security context of the Binary resources resulting from the export is the user that initiated the export. The files can therefore only be retrieved by the same user.\n### Retention of exported files\nThe exported files are retained for a limited time after which they are deleted. The retention time is a server configuration with default 2 hours.", "operationId": "op-export-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$meta": { "summary": "System level operation $meta", "description": "Operation $meta invoked at the system level", "post": { "summary": "$meta (system)", "operationId": "op-meta-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$get-resource-counts": { "summary": "System level operation $get-resource-counts", "description": "Operation $get-resource-counts invoked at the system level", "post": { "summary": "$get-resource-counts (system)", "description": "Provides the number of resources currently stored on the server, broken down by resource type", "operationId": "op-get-resource-counts-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$expunge": { "summary": "System level operation $expunge", "description": "Operation $expunge invoked at the system level", "post": { "summary": "$expunge (system)", "operationId": "op-expunge-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } } }, "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" } } } } }