XIG: CapabilityStatement/CH.MHD.DocumentConsumer

FHIR IG Statistics: CapabilityStatement/CH.MHD.DocumentConsumer

Package	ch.fhir.ig.ch-epr-fhir
Type	CapabilityStatement
Id	CH.MHD.DocumentConsumer
FHIR Version	R4
Source	http://fhir.ch/ig/ch-epr-fhir/https://build.fhir.org/ig/ehealthsuisse/ch-epr-fhir/CapabilityStatement-CH.MHD.DocumentConsumer.html
URL	http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentConsumer
Version	5.0.0-ci-build
Status	active
Date	2020-07-08
Name	CH_MHD_DocumentConsumer
Title	MHD Document Consumer (client)
Realm	ch
Authority	hl7
Description	CapabilityStatement for Actor MHD Document Consumer (client).
Copyright	CC0-1.0
Kind	requirements

Resources that use this resource

CapabilityStatement
CH.EPR.App	EPR App (client)

Resources that this resource uses

SearchParameter
DocumentReference-Creation	Creation

StructureDefinition
ch-mhd-documentreference-comprehensive	CH MHD DocumentReference Comprehensive
ch-mhd-submissionset-comprehensive	CH MHD SubmissionSet Comprehensive

Narrative

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

Generated Narrative: CapabilityStatement CH.MHD.DocumentConsumer

MHD Document Consumer (client)

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: `client`

MHD client requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder [ITI-67]. MHD client requests a document from the Document Responder [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 Type	Profile	R	S	Searches
DocumentReference	http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive	y	y	_id, _lastUpdated, author, category, date, event, facility, format, identifier, patient, period, related, security-label, setting, status, type
List	http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive	y	y	_id, _lastupdated, code, creation, date, identifier, subject
Binary		y

Resource Conformance: supported DocumentReference

Base System Profile
CH MHD DocumentReference Comprehensive

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	_lastUpdated	`date`	When the resource version last changed
SHALL	author	`reference`	Who and/or what authored the document
SHALL	category	`token`	Categorization of document
SHALL	date	`date`	When this document reference was created
SHALL	event	`token`	Main clinical acts documented
SHALL	facility	`token`	Kind of facility where patient was seen
SHALL	format	`token`	Format/content rules for the document
SHALL	identifier	`token`	The identifier for this DocumentReference
SHALL	patient	`reference`	Who/what is the subject of the document
SHALL	period	`date`	Time of service that is being documented
SHALL	related	`reference`	Related Resource
SHALL	security-label	`token`	Document security-tags
SHALL	setting	`token`	Additional details about where the content was created (e.g. clinical specialty)
SHALL	status	`token`	current \| superseded \| entered-in-error
SHALL	type	`token`	Kind of document (LOINC if possible)

Resource Conformance: supported List

Base System Profile
CH MHD SubmissionSet Comprehensive

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id of this artifact
SHALL	_lastupdated	`date`	When the resource version last changed
SHALL	code	`token`	This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated.
SHALL	creation	`date`	When this document was created
SHALL	date	`date`	This parameter, of type date, specifies the time when the List was created.
SHALL	identifier	`token`	This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2: Appendix Z.2 for additional constraints on the use of the token search parameter type.
SHALL	subject	`reference`	This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder.

Resource Conformance: supported Binary

Core FHIR Resource
Binary

Reference Policy

Interaction summary

Supports read.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "CH.MHD.DocumentConsumer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.MHD.DocumentConsumer",
  "version": "5.0.0-ci-build",
  "name": "CH_MHD_DocumentConsumer",
  "title": "MHD Document Consumer (client)",
  "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 Consumer (client).",
  "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": "client",
      "documentation": "MHD client requests a list of DocumentReference Resources, matching the supplied set of criteria, from the Document Responder [ITI-67]. MHD client requests a document from the Document Responder [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"
            }
          ],
          "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": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
              "type": "date",
              "documentation": "When this document reference was created"
            },
            {
              "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": "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": "List",
          "profile": "http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-mhd-submissionset-comprehensive",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "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": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated."
            },
            {
              "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/clinical-date",
              "type": "date",
              "documentation": "This parameter, of type date, specifies the time when the List was created."
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2: Appendix Z.2 for additional constraints on the use of the token search parameter type."
            },
            {
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder."
            }
          ]
        },
        {
          "type": "Binary",
          "interaction": [
            {
              "code": "read"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "search-system"
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/CH.MHD.DocumentConsumer

Resources that use this resource

Resources that this resource uses

Narrative

MHD Document Consumer (client)

FHIR RESTful Capabilities

Mode: client

Capabilities by Resource/Profile

Summary

Resource Conformance: supported DocumentReference

Resource Conformance: supported List

Resource Conformance: supported Binary

Source

Mode: `client`