{ "openapi": "3.0.2", "info": { "title": "document-transformation", "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://document-transformation.devtest.systematic-ehealth.com/fhir", "description": "eHealth document-transformation service" } ], "externalDocs": { "url": "http://ehealth.sundhed.dk/fhir/CapabilityStatement/document-transformation", "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" } ] } }, "/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" } ] } }, "/Composition": { "summary": "Manager for resources of type Composition", "description": "The Manager for resources of type Composition: provides services to manage the collection of all the Composition instances", "get": { "summary": "Search all resources of type Composition based on a set of criteria", "operationId": "searchComposition", "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": "_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": "attester", "in": "query", "description": "Who attested the composition", "schema": { "type": "string" } }, { "name": "author", "in": "query", "description": "Who and/or what authored the composition", "schema": { "type": "string" } }, { "name": "class", "in": "query", "description": "Categorization of Composition", "schema": { "type": "string" } }, { "name": "confidentiality", "in": "query", "description": "As defined by affinity domain", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Code(s) that apply to the event being documented", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Composition editing time", "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": "encounter", "in": "query", "description": "Context of the Composition", "schema": { "type": "string" } }, { "name": "entry", "in": "query", "description": "A reference to data that supports this section", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Logical identifier of composition (version-independent)", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Who and/or what the composition is about", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "The period covered by the documentation", "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-id", "in": "query", "description": "Target of the relationship", "schema": { "type": "string" } }, { "name": "related-ref", "in": "query", "description": "Target of the relationship", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "Classification of section (recommended)", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "preliminary | final | amended | entered-in-error", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Who and/or what the composition is about", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Human Readable name/title", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Kind of composition (LOINC if possible)", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createComposition", "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/Composition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Composition.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/Composition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Composition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Composition/{rid}": { "summary": "Read/Write/etc resource instance of type Composition", "description": "Access to services to manage the state of a single resource of type Composition", "get": { "summary": "Read the current state of the resource", "operationId": "readComposition", "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/Composition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Composition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteComposition", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/Composition/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Composition", "description": "Access a to specified previous version of a single resource of type Composition", "get": { "summary": "Read a past state of the resource", "operationId": "vreadComposition", "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/Composition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Composition.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": "_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": "_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": "class", "in": "query", "description": "Categorization of document", "schema": { "type": "string" } }, { "name": "custodian", "in": "query", "description": "Organization which maintains the document", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Document creation time", "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 (title)", "schema": { "type": "string" } }, { "name": "documentSharingState", "in": "query", "description": "Sharing State of the Document", "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": "indexed", "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": "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": "masterIdentifier", "in": "query", "description": "Master identifier", "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": "related-id", "in": "query", "description": "Identifier of related objects or events", "schema": { "type": "string" } }, { "name": "related-ref", "in": "query", "description": "Related Resource", "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": "securitylabel", "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" } } ] }, "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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchDocumentReference", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/DocumentReference" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DocumentReference.xsd" } }, "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": "the resource being returned after being patched", "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" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteDocumentReference", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/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" } ] } }, "/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" } } } } } } }, "/Composition/$validate": { "summary": "Operation $validate on type Composition", "description": "Operation $validate on type Composition", "post": { "summary": "$validate on type Composition", "operationId": "op-validate-Composition", "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" } } } } } } }, "/DocumentReference/$deprecate-document": { "summary": "Operation $deprecate-document on type DocumentReference", "description": "Operation $deprecate-document on type DocumentReference", "post": { "summary": "$deprecate-document on type DocumentReference", "description": "Deprecates a shared document. The operation takes a documentIdentifier and cpr-number as parameters and finds the DocumentReference with the corresponding masterIdentifier. masterIdentifier should be unique for DocumentReference so if less than 0 or more than 1 are found the operation throws and exception. If the found documentReference has a patient which cpr number matches the provided value the document is deprecated. iti-57 is used to deprecate the document on XDS. On successthe documentReference status is updated to superseded and updated in the database.", "operationId": "op-deprecate-document-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" } } } } } } }, "/$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" } } } } } } }, "/$upload-QFDD": { "summary": "System level operation $upload-QFDD", "description": "Operation $upload-QFDD invoked at the system level", "post": { "summary": "$upload-QFDD (system)", "description": "Uploads an DK-HL7 Questionnaire Form Definition Document (QFDD). The input FHIR DocumentReference must be of type QFDD (74468-0) and the status set to current. Include an attachment which contains the base64 encoded QFDD XML document with contentType application/xml. The QFDD XML document must contain a unique id which is used as the the masterIdentifier in the DocumentReference. The returned FHIR DocumentReference contains a masterIdentifier, a type and the description all pulled from the attachment.", "operationId": "op-upload-QFDD-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" } } } } } } }, "/$transform-to-QRD": { "summary": "System level operation $transform-to-QRD", "description": "Operation $transform-to-QRD invoked at the system level", "post": { "summary": "$transform-to-QRD (system)", "description": "Transforms a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource to a DK-HL7 Questionnaire Response Document (QRD) XML document. The input FHIR Bundle contains FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse resource. a FHIR Questionnaire resource. The bundle must also contain a FHIR DocumentReference containing a QFDD xml file (base64 encoded)The returned FHIR DocumentReference contains the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile.", "operationId": "op-transform-to-QRD-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" } } } } } } }, "/$transform-to-QFDD": { "summary": "System level operation $transform-to-QFDD", "description": "Operation $transform-to-QFDD invoked at the system level", "post": { "summary": "$transform-to-QFDD (system)", "description": "Transforms an eHealth Questionnaire resource to the DK-HL7 Questionnaire Form Definition Document (QFDD). The input Bundle contains an eHealth Questionnaire and Composition resource which reference the returned eHealth Questionnaire. The returned Bundle in case of no validation errors contains the FHIR DocumentReference containing the QFDD XML for the DK-HL7 Questionnaire Form Definition Document and an OperationOutcome will possible warnings. In case of validation errors the Bundle will only contain an OperationOutcome with the validation errors/warnings.", "operationId": "op-transform-to-QFDD-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" } } } } } } }, "/$transform-to-PHMR": { "summary": "System level operation $transform-to-PHMR", "description": "Operation $transform-to-PHMR invoked at the system level", "post": { "summary": "$transform-to-PHMR (system)", "description": "Transforms a FHIR Observation (ehealth-observation profile) resource to a DK-HL7 Personal Health Monitoring Report (PHMR) XML document. The input FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing one or more FHIR Observation (ehealth-observation profile) resources and referenced resources such as FHIR Organization. The returned FHIR DocumentReference contains the PHMR XML document adhering to the DK-HL7 Personal Health Monitoring Report profile.", "operationId": "op-transform-to-PHMR-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" } } } } } } }, "/$transform-to-APD": { "summary": "System level operation $transform-to-APD", "description": "Operation $transform-to-APD invoked at the system level", "post": { "summary": "$transform-to-APD (system)", "description": "Transforms a FHIR Appointment (ehealth-appointment profile) resource to a DK-HL7 Appointment Document (APD) XML document. The input FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing a FHIR Appointment (ehealth-appointment profile) resource and referenced resources such as FHIR Organization. The returned FHIR DocumentReference contains the APD XML document adhering to the DK-HL7 Appointment Document profile.", "operationId": "op-transform-to-APD-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" } } } } } } }, "/$transform-from-QRD-based-on-questionnaire": { "summary": "System level operation $transform-from-QRD-based-on-questionnaire", "description": "Operation $transform-from-QRD-based-on-questionnaire invoked at the system level", "post": { "summary": "$transform-from-QRD-based-on-questionnaire (system)", "description": "Transforms a DK-HL7 Questionnaire Response Document (QRD) XML document to a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource. The input bundle must contain the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile. And a FHIR Questionnaire resource. The returned FHIR Bundle contains FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse (ehealth-documentreference profile) resource.", "operationId": "op-transform-from-QRD-based-on-questionnaire-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" } } } } } } }, "/$transform-from-QRD": { "summary": "System level operation $transform-from-QRD", "description": "Operation $transform-from-QRD invoked at the system level", "post": { "summary": "$transform-from-QRD (system)", "description": "Transforms a DK-HL7 Questionnaire Response Document (QRD) XML document to a FHIR QuestionnaireResponse (ehealth-questionnaireresponse profile) resource. The input FHIR DocumentReference contains the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile. The returned FHIR Bundle contains FHIR Composition (ehealth-composition profile) resource referencing a FHIR QuestionnaireResponse (ehealth-documentreference profile) resource.", "operationId": "op-transform-from-QRD-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" } } } } } } }, "/$transform-from-QFDD": { "summary": "System level operation $transform-from-QFDD", "description": "Operation $transform-from-QFDD invoked at the system level", "post": { "summary": "$transform-from-QFDD (system)", "description": "Transforms the DK-HL7 Questionnaire Form Definition Document (QFDD) to an eHealth Questionnaire resource. The input FHIR DocumentReference contains QFDD XML for the DK-HL7 Questionnaire Form Definition Document. The returned Bundle contains the eHealth Questionnaire and Composition resource which reference the returned eHealth Questionnaire.", "operationId": "op-transform-from-QFDD-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" } } } } } } }, "/$transform-from-PHMR": { "summary": "System level operation $transform-from-PHMR", "description": "Operation $transform-from-PHMR invoked at the system level", "post": { "summary": "$transform-from-PHMR (system)", "description": "Transforms a DK-HL7 Personal Health Monitoring Report (PHMR) XML document to FHIR Observation (ehealth-observation profile) resource. The input FHIR DocumentReference contains the PHMR XML document adhering to the DK-HL7 Personal Health Monitoring Report profile The returned FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing.one or more FHIR Observation (ehealth-observation profile) resources and referenced resources such as FHIR Organization.", "operationId": "op-transform-from-PHMR-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" } } } } } } }, "/$transform-from-APD": { "summary": "System level operation $transform-from-APD", "description": "Operation $transform-from-APD invoked at the system level", "post": { "summary": "$transform-from-APD (system)", "description": "Transforms a DK-HL7 Appointment Document (APD) XML document to a FHIR Appointment (ehealth-appointment profile) resource. The input FHIR DocumentReference (ehealth-documentreference profile) contains the APD XML document. The caller must ensure that the APD XML document is valid and adheres to the DK-HL7 Appointment Document profile. The returned FHIR Bundle contains a FHIR Composition (ehealth-composition profile) resource referencing a FHIR Appointment (ehealth-appointment profile) resource.", "operationId": "op-transform-from-APD-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" } } } } }