FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/CH.MHD.DocumentResponder

Packagech.fhir.ig.ch-epr-fhir
TypeCapabilityStatement
IdCH.MHD.DocumentResponder
FHIR VersionR4
Sourcehttp://fhir.ch/ig/ch-epr-fhir/https://build.fhir.org/ig/ehealthsuisse/ch-epr-fhir/CapabilityStatement-CH.MHD.DocumentResponder.html
URLhttp://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentResponder
Version5.0.0-ci-build
Statusactive
Date2020-07-08
NameCH_MHD_DocumentResponder
TitleMHD Document Responder (server)
Realmch
Authorityhl7
DescriptionCapabilityStatement for Actor MHD Document Responder (server).
CopyrightCC0-1.0
Kindrequirements

Resources that use this resource

CapabilityStatement
CH.EPR.APIEPR API (server)

Resources that this resource uses

SearchParameter
DocumentReference-CreationCreation
StructureDefinition
ch-mhd-documentreference-comprehensiveCH MHD DocumentReference Comprehensive

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement CH.MHD.DocumentResponder

MHD Document Responder (server)

  • Implementation Guide Version: 5.0.0-ci-build
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2020-07-08
  • Published by: eHealth Suisse

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

MHD server returns DocumentReference Resources that match the search criteria provided by the Document Consumer [ITI-67]. MHD supports update of DocumentReference Resources by the Document Source [CH:MHD-1]. MHD server serves the document to the Document Consumer [ITI-68].

Security

TLS SHALL be used together with IUA extended access token

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DocumentReferencehttp://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensiveyyy_id, _lastUpdated, author, category, event, facility, format, creation, date, identifier, patient, period, related, security-label, setting, status, type
Binary y

Resource Conformance: supported DocumentReference

Base System Profile
CH MHD DocumentReference Comprehensive
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

SHALLauthorreference

Who and/or what authored the document

SHALLcategorytoken

Categorization of document

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLcreationdate

When this document was created

SHALLdatedate

When this document reference was created

SHALLidentifiertoken

The identifier for this DocumentReference

SHALLpatientreference

Who/what is the subject of the document

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related Resource

SHALLsecurity-labeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLtypetoken

Kind of document (LOINC if possible)

 

Resource Conformance: supported Binary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports read.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "CH.MHD.DocumentResponder",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentResponder",
  "version": "5.0.0-ci-build",
  "name": "CH_MHD_DocumentResponder",
  "title": "MHD Document Responder (server)",
  "status": "active",
  "date": "2020-07-08",
  "publisher": "eHealth Suisse",
  "contact": [
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch"
        }
      ]
    },
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch",
          "use": "work"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for Actor MHD Document Responder (server).",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CH"
        }
      ]
    }
  ],
  "copyright": "CC0-1.0",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "MHD server returns DocumentReference Resources that match the search criteria provided by the Document Consumer [ITI-67]. MHD supports update of DocumentReference Resources by the Document Source [CH:MHD-1]. MHD server serves the document to the Document Consumer [ITI-68].",
      "security": {
        "cors": false,
        "description": "TLS SHALL be used together with IUA extended access token"
      },
      "resource": [
        {
          "type": "DocumentReference",
          "profile": "http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "update"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "author",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
              "type": "reference",
              "documentation": "Who and/or what authored the document"
            },
            {
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
              "type": "token",
              "documentation": "Categorization of document"
            },
            {
              "name": "event",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
              "type": "token",
              "documentation": "Main clinical acts documented"
            },
            {
              "name": "facility",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
              "type": "token",
              "documentation": "Kind of facility where patient was seen"
            },
            {
              "name": "format",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
              "type": "token",
              "documentation": "Format/content rules for the document"
            },
            {
              "name": "creation",
              "definition": "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
              "type": "date",
              "documentation": "When this document was created"
            },
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
              "type": "date",
              "documentation": "When this document reference was created"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "The identifier for this DocumentReference"
            },
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Who/what is the subject of the document"
            },
            {
              "name": "period",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
              "type": "date",
              "documentation": "Time of service that is being documented"
            },
            {
              "name": "related",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
              "type": "reference",
              "documentation": "Related Resource"
            },
            {
              "name": "security-label",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
              "type": "token",
              "documentation": "Document security-tags"
            },
            {
              "name": "setting",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
              "type": "token",
              "documentation": "Additional details about where the content was created (e.g. clinical specialty)"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
              "type": "token",
              "documentation": "current | superseded | entered-in-error"
            },
            {
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
              "type": "token",
              "documentation": "Kind of document (LOINC if possible)"
            }
          ]
        },
        {
          "type": "Binary",
          "interaction": [
            {
              "code": "read"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}