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

FHIR IG Statistics: CapabilityStatement/medmorph-data-receiver

Packagehl7.fhir.us.medmorph
TypeCapabilityStatement
Idmedmorph-data-receiver
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/medmorph/https://build.fhir.org/ig/HL7/fhir-medmorph/CapabilityStatement-medmorph-data-receiver.html
URLhttp://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver
Version1.0.0
Statusdraft
Date2020-12-06
NameDataReceiver
TitleExample Data Receiver Capability Statement
Realmus
Authorityhl7
DescriptionThis example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG. The actor is responsible for defining Knowledge Artifacts, receiving reports, and submitting responses back to health care organizations. The specific knowlege artifacts, reports and responses to be supported by the Data Receiver will be defined by the Content IGs.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
us-ph-plandefinitionUS Public Health PlanDefinition

Narrative

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

DataReceiver

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver

Published by: HL7 International - Public Health Work Group

This example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG. The actor is responsible for defining Knowledge Artifacts, receiving public health reports, and submitting responses back to health care organizations. The specific knowledge artifacts, reports, and responses supported by the Data Receiver will be defined by the content IGs.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the Data Receiver is to define Knowledge Artifacts, receive reports and submit responses back to clinical care organizations.

Security:

Implementations must meet the general security requirements documented in FHIR Security guidance.

In addition the Data Receiver needs to meet the security requirements as outlined in the Formal Specification - Security Section.

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
PlanDefinition (Profile) SHALL SHALL SHOULD SHALL SHALL

FHIR Operations summary

The following FHIR operations SHALL be supported by the Data Receiver.



PlanDefinition

Profile: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition

Interactions

Name Description
  search-type

Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.

  read

Allows retrieval of a specific PlanDefinition instance.

  vread

Allows retrieval of a historical version of a PlanDefinition instance.

  create

Allows creation of PlanDefinition instances

  update

Allows Update of PlanDefinition instances



Search

Parameter Type Definition & Chaining
identifier token Search using identifiers as allowed according to the FHIR specification.
name string Search using PlanDefinition name.
publisher string Search using publisher name.
title string Search using title.
version string Search using version.
name and version string, string Search using name and version.



Source

{
  "resourceType": "CapabilityStatement",
  "id": "medmorph-data-receiver",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver",
  "version": "1.0.0",
  "name": "DataReceiver",
  "title": "Example Data Receiver Capability Statement",
  "status": "draft",
  "date": "2020-12-06",
  "publisher": "HL7 International - Public Health Work Group",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description": "This example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG.     The actor is responsible for defining Knowledge Artifacts, receiving reports, and submitting responses back to health care organizations.   The specific knowlege artifacts, reports and responses to be supported by the Data Receiver will be defined by the Content IGs.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "The focus of the Data Receiver is to for define Knowledge Artifacts, receive reports and submit responses back to clinical care organizations. ",
      "security": {
        "description": "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "resource": [
        {
          "type": "PlanDefinition",
          "supportedProfile": [
            "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing PlanDefinition instances."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific PlanDefinition instance."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a PlanDefinition instance."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows creation of a PlanDefinition resource instance."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows update of a PlanDefinition resource instance."
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "publisher",
              "definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
              "type": "string"
            }
          ]
        }
      ],
      "operation": [
        {
          "name": "process-message",
          "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
        }
      ]
    },
    {
      "mode": "server",
      "documentation": "The focus of the Data Receiver as a Server is to expose $process-message endpoint at the root of the FHIR server.",
      "security": {
        "description": "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "operation": [
        {
          "name": "process-message",
          "definition": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
        }
      ]
    }
  ]
}