eHealth Infrastructure
2.3.0 - release

eHealth Infrastructure - Local Development build (v2.3.0). See the Directory of published versions

: document-transformation - JSON Representation

Active as of 2022-09-16

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "document-transformation",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>document-transformation</h2><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title=\"GET a resource (read interaction)\">Read</b></th><th><b title=\"GET past versions of resources (vread interaction)\">V-Read</b></th><th><b title=\"GET all set of resources of the type (search interaction)\">Search</b></th><th><b title=\"PUT a new resource version (update interaction)\">Update</b></th><th><b title=\"POST a new resource (create interaction)\">Create</b></th><th><b title=\"DELETE a resource (delete interaction)\">Delete</b></th></tr><tr><td>Composition</td><td><a href=\"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-composition\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-composition</a></td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td>y</td></tr><tr><td>DocumentReference</td><td><a href=\"http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference</a></td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td>y</td></tr><tr><td>OperationDefinition</td><td><a href=\"http://hl7.org/fhir/StructureDefinition/OperationDefinition\">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td>y</td><td></td><td></td><td></td><td></td><td></td></tr></table></div>"
  },
  "url" : "http://ehealth.sundhed.dk/fhir/CapabilityStatement/document-transformation",
  "version" : "2.3.0",
  "name" : "document-transformation",
  "status" : "active",
  "date" : "2022-09-16T10:36:58.418+00:00",
  "publisher" : "Systematic | Trifork",
  "contact" : [
    {
      "name" : "Systematic | Trifork",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "kind" : "instance",
  "software" : {
    "name" : "document-transformation",
    "version" : "1.9.0"
  },
  "implementation" : {
    "description" : "eHealth document-transformation service",
    "url" : "https://document-transformation.devtest.systematic-ehealth.com/fhir"
  },
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "xml",
    "application/fhir+json",
    "json",
    "application/x-turtle",
    "ttl",
    "html/json",
    "html/xml",
    "html/turtle"
  ],
  "rest" : [
    {
      "mode" : "server",
      "resource" : [
        {
          "type" : "Composition",
          "profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-composition",
          "interaction" : [
            {
              "code" : "search-type"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "read"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "create"
            }
          ],
          "conditionalCreate" : true,
          "conditionalDelete" : "multiple",
          "searchInclude" : [
            "Composition:related-ref"
          ],
          "searchRevInclude" : [
            "Composition:attester",
            "Composition:author",
            "Composition:encounter",
            "Composition:entry",
            "Composition:patient",
            "Composition:related-ref",
            "Composition:subject",
            "DocumentReference:authenticator",
            "DocumentReference:author",
            "DocumentReference:custodian",
            "DocumentReference:encounter",
            "DocumentReference:patient",
            "DocumentReference:related",
            "DocumentReference:related-ref",
            "DocumentReference:relatesto",
            "DocumentReference:subject"
          ],
          "searchParam" : [
            {
              "name" : "_content",
              "type" : "string",
              "documentation" : "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name" : "_has",
              "type" : "string",
              "documentation" : "Return resources linked to by the given target"
            },
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "_language",
              "type" : "string",
              "documentation" : "The language of the resource"
            },
            {
              "name" : "_lastUpdated",
              "type" : "date",
              "documentation" : "Only return resources which were last updated as specified by the given range"
            },
            {
              "name" : "_profile",
              "type" : "uri",
              "documentation" : "Search for resources which have the given profile"
            },
            {
              "name" : "_security",
              "type" : "token",
              "documentation" : "Search for resources which have the given security labels"
            },
            {
              "name" : "_tag",
              "type" : "token",
              "documentation" : "Search for resources which have the given tag"
            },
            {
              "name" : "_text",
              "type" : "string",
              "documentation" : "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name" : "attester",
              "type" : "reference",
              "documentation" : "Who attested the composition"
            },
            {
              "name" : "author",
              "type" : "reference",
              "documentation" : "Who and/or what authored the composition"
            },
            {
              "name" : "class",
              "type" : "token",
              "documentation" : "Categorization of Composition"
            },
            {
              "name" : "confidentiality",
              "type" : "token",
              "documentation" : "As defined by affinity domain"
            },
            {
              "name" : "context",
              "type" : "token",
              "documentation" : "Code(s) that apply to the event being documented"
            },
            {
              "name" : "date",
              "type" : "date",
              "documentation" : "Composition editing time"
            },
            {
              "name" : "encounter",
              "type" : "reference",
              "documentation" : "Context of the Composition"
            },
            {
              "name" : "entry",
              "type" : "reference",
              "documentation" : "A reference to data that supports this section"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "Logical identifier of composition (version-independent)"
            },
            {
              "name" : "patient",
              "type" : "reference",
              "documentation" : "Who and/or what the composition is about"
            },
            {
              "name" : "period",
              "type" : "date",
              "documentation" : "The period covered by the documentation"
            },
            {
              "name" : "related-id",
              "type" : "token",
              "documentation" : "Target of the relationship"
            },
            {
              "name" : "related-ref",
              "type" : "reference",
              "documentation" : "Target of the relationship"
            },
            {
              "name" : "section",
              "type" : "token",
              "documentation" : "Classification of section (recommended)"
            },
            {
              "name" : "status",
              "type" : "token",
              "documentation" : "preliminary | final | amended | entered-in-error"
            },
            {
              "name" : "subject",
              "type" : "reference",
              "documentation" : "Who and/or what the composition is about"
            },
            {
              "name" : "title",
              "type" : "string",
              "documentation" : "Human Readable name/title"
            },
            {
              "name" : "type",
              "type" : "token",
              "documentation" : "Kind of composition (LOINC if possible)"
            }
          ],
          "operation" : [
            {
              "name" : "validate",
              "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/CompositionDocumentReference-it-validate"
            }
          ]
        },
        {
          "type" : "DocumentReference",
          "profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference",
          "interaction" : [
            {
              "code" : "search-type"
            },
            {
              "code" : "vread"
            },
            {
              "code" : "read"
            },
            {
              "code" : "delete"
            },
            {
              "code" : "create"
            }
          ],
          "conditionalCreate" : true,
          "conditionalDelete" : "multiple",
          "searchInclude" : [
            "DocumentReference:relatesto"
          ],
          "searchRevInclude" : [
            "Composition:attester",
            "Composition:author",
            "Composition:encounter",
            "Composition:entry",
            "Composition:patient",
            "Composition:related-ref",
            "Composition:subject",
            "DocumentReference:authenticator",
            "DocumentReference:author",
            "DocumentReference:custodian",
            "DocumentReference:encounter",
            "DocumentReference:patient",
            "DocumentReference:related",
            "DocumentReference:related-ref",
            "DocumentReference:relatesto",
            "DocumentReference:subject"
          ],
          "searchParam" : [
            {
              "name" : "_content",
              "type" : "string",
              "documentation" : "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name" : "_has",
              "type" : "string",
              "documentation" : "Return resources linked to by the given target"
            },
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "The ID of the resource"
            },
            {
              "name" : "_language",
              "type" : "string",
              "documentation" : "The language of the resource"
            },
            {
              "name" : "_lastUpdated",
              "type" : "date",
              "documentation" : "Only return resources which were last updated as specified by the given range"
            },
            {
              "name" : "_profile",
              "type" : "uri",
              "documentation" : "Search for resources which have the given profile"
            },
            {
              "name" : "_security",
              "type" : "token",
              "documentation" : "Search for resources which have the given security labels"
            },
            {
              "name" : "_tag",
              "type" : "token",
              "documentation" : "Search for resources which have the given tag"
            },
            {
              "name" : "_text",
              "type" : "string",
              "documentation" : "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name" : "authenticator",
              "type" : "reference",
              "documentation" : "Who/what authenticated the document"
            },
            {
              "name" : "author",
              "type" : "reference",
              "documentation" : "Who and/or what authored the document"
            },
            {
              "name" : "class",
              "type" : "token",
              "documentation" : "Categorization of document"
            },
            {
              "name" : "custodian",
              "type" : "reference",
              "documentation" : "Organization which maintains the document"
            },
            {
              "name" : "date",
              "type" : "date",
              "documentation" : "Document creation time"
            },
            {
              "name" : "description",
              "type" : "string",
              "documentation" : "Human-readable description (title)"
            },
            {
              "name" : "encounter",
              "type" : "reference",
              "documentation" : "Context of the document  content"
            },
            {
              "name" : "event",
              "type" : "token",
              "documentation" : "Main clinical acts documented"
            },
            {
              "name" : "facility",
              "type" : "token",
              "documentation" : "Kind of facility where patient was seen"
            },
            {
              "name" : "format",
              "type" : "token",
              "documentation" : "Format/content rules for the document"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "Master Version Specific Identifier"
            },
            {
              "name" : "indexed",
              "type" : "date",
              "documentation" : "When this document reference was created"
            },
            {
              "name" : "language",
              "type" : "token",
              "documentation" : "Human language of the content (BCP-47)"
            },
            {
              "name" : "location",
              "type" : "uri",
              "documentation" : "Uri where the data can be found"
            },
            {
              "name" : "patient",
              "type" : "reference",
              "documentation" : "Who/what is the subject of the document"
            },
            {
              "name" : "period",
              "type" : "date",
              "documentation" : "Time of service that is being documented"
            },
            {
              "name" : "related",
              "type" : "reference",
              "documentation" : "Related identifiers or resources"
            },
            {
              "name" : "related-id",
              "type" : "token",
              "documentation" : "Identifier of related objects or events"
            },
            {
              "name" : "related-ref",
              "type" : "reference",
              "documentation" : "Related Resource"
            },
            {
              "name" : "relatesto",
              "type" : "reference",
              "documentation" : "Target of the relationship"
            },
            {
              "name" : "relation",
              "type" : "token",
              "documentation" : "replaces | transforms | signs | appends"
            },
            {
              "name" : "relationship",
              "type" : "composite",
              "documentation" : "Combination of relation and relatesTo"
            },
            {
              "name" : "securitylabel",
              "type" : "token",
              "documentation" : "Document security-tags"
            },
            {
              "name" : "setting",
              "type" : "token",
              "documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
            },
            {
              "name" : "status",
              "type" : "token",
              "documentation" : "current | superseded | entered-in-error"
            },
            {
              "name" : "subject",
              "type" : "reference",
              "documentation" : "Who/what is the subject of the document"
            },
            {
              "name" : "type",
              "type" : "token",
              "documentation" : "Kind of document (LOINC if possible)"
            }
          ],
          "operation" : [
            {
              "name" : "validate",
              "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/CompositionDocumentReference-it-validate"
            }
          ]
        },
        {
          "type" : "OperationDefinition",
          "profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
          "interaction" : [
            {
              "code" : "read"
            }
          ],
          "searchInclude" : [
            "*"
          ],
          "searchRevInclude" : [
            "Composition:attester",
            "Composition:author",
            "Composition:encounter",
            "Composition:entry",
            "Composition:patient",
            "Composition:related-ref",
            "Composition:subject",
            "DocumentReference:authenticator",
            "DocumentReference:author",
            "DocumentReference:custodian",
            "DocumentReference:encounter",
            "DocumentReference:patient",
            "DocumentReference:related",
            "DocumentReference:related-ref",
            "DocumentReference:relatesto",
            "DocumentReference:subject"
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "transaction"
        },
        {
          "code" : "history-system"
        }
      ],
      "operation" : [
        {
          "name" : "transform-to-QRD",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-to-QRD",
          "documentation" : "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 (ehealth-documentreference profile) resource. The returned FHIR DocumentReference contains the QRD XML document adhering to the DK-HL7 Questionnaire Response Document profile."
        },
        {
          "name" : "transform-to-QFDD",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-to-QFDD",
          "documentation" : "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 FHIR DocumentReference contains QFDD XML for the DK-HL7 Questionnaire Form Definition Document."
        },
        {
          "name" : "transform-to-PHMR",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-to-PHMR",
          "documentation" : "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."
        },
        {
          "name" : "transform-to-APD",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-to-APD",
          "documentation" : "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."
        },
        {
          "name" : "transform-from-QRD",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-from-QRD",
          "documentation" : "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."
        },
        {
          "name" : "transform-from-QFDD",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-from-QFDD",
          "documentation" : "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."
        },
        {
          "name" : "transform-from-PHMR",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-from-PHMR",
          "documentation" : "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."
        },
        {
          "name" : "transform-from-APD",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-transform-from-APD",
          "documentation" : "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."
        },
        {
          "name" : "meta",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"
        },
        {
          "name" : "get-resource-counts",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-resource-counts",
          "documentation" : "Provides the number of resources currently stored on the server, broken down by resource type"
        },
        {
          "name" : "reindex-terminology",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex-terminology"
        },
        {
          "name" : "process-message",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-process-message",
          "documentation" : "Accept a FHIR Message Bundle for processing"
        },
        {
          "name" : "perform-reindexing-pass",
          "definition" : "https://document-transformation.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-perform-reindexing-pass",
          "documentation" : "Forces a single pass of the resource reindexing processor"
        }
      ]
    }
  ]
}