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

FHIR IG Statistics: CapabilityStatement/mcode-sender-patient-bundle

Packagehl7.fhir.us.mcode
TypeCapabilityStatement
Idmcode-sender-patient-bundle
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/mcode/https://build.fhir.org/ig/HL7/fhir-mCODE-ig/CapabilityStatement-mcode-sender-patient-bundle.html
URLhttp://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-patient-bundle
Version4.0.0
Statusdraft
Date2020-10-30T07:15:00.000000-04:00
NameCapabilityStatementPatientBundle
TitlemCODE Data Sender: Get Bundle for a Patient
Realmus
Authorityhl7
DescriptionRetrieves a Bundle of Condition resources with a code in mCODE's cancer condition value set, and allows for associated Patient resources to be retrieved in a subsequent request. Use ONLY when reverse chaining AND `_include` are not available on the system.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
us-core-serverUS Core Server CapabilityStatement
ImplementationGuide
hl7.fhir.us.mcodeminimal Common Oncology Data Elements (mCODE) Implementation Guide
OperationDefinition
mcode-patient-everythingFetch mCODE Patient Bundle for a given Patient

Narrative

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

Generated Narrative: CapabilityStatement mcode-sender-patient-bundle

mCODE Data Sender: Get Bundle for a Patient

  • Implementation Guide Version: 4.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2020-10-30 07:15:00-0400
  • Published by: HL7 International / Clinical Interoperability Council

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.

This CapabilityStatement imports the CapabilityStatement US Core Server CapabilityStatement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

An mCODE Server SHALL:

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  4. Support json source formats for all mCODE interactions.
  5. Identify the mCODE profiles supported as part of the FHIR meta.profile attribute for each instance.
  6. Support the searchParameters on each profile individually and in combination.

The mCODE Server SHOULD:

  1. Support xml source formats for all mCODE interactions.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
Summary of System-wide Interactions

Operations

Use


Source

{
  "resourceType": "CapabilityStatement",
  "id": "mcode-sender-patient-bundle",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cic"
    }
  ],
  "url": "http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-patient-bundle",
  "version": "4.0.0",
  "name": "CapabilityStatementPatientBundle",
  "title": "mCODE Data Sender: Get Bundle for a Patient",
  "status": "draft",
  "experimental": true,
  "date": "2020-10-30T07:15:00.000000-04:00",
  "publisher": "HL7 International / Clinical Interoperability Council",
  "contact": [
    {
      "name": "HL7 International / Clinical Interoperability Council",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cic"
        },
        {
          "system": "email",
          "value": "ciclist@lists.HL7.org"
        }
      ]
    }
  ],
  "description": "Retrieves a Bundle of Condition resources with a code in mCODE's cancer condition value set, and allows for associated Patient resources to be retrieved in a subsequent request. Use ONLY when reverse chaining AND `_include` are not available on the system.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "imports": [
    "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"
  ],
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "An mCODE Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide..\n1.  Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n   - (Status 400): invalid parameter\n   - (Status 401/4xx): unauthorized request\n   - (Status 403): insufficient scope\n   - (Status 404): unknown resource\n   - (Status 410): deleted resource.\n1. Support json source formats for all mCODE interactions.\n1. Identify the mCODE  profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n1. Support the searchParameters on each profile individually and in combination.\n\nThe mCODE Server **SHOULD**:\n\n1. Support xml source formats for all mCODE interactions.\n",
      "security": {
        "description": "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
      },
      "operation": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "mcode-patient-bundle",
          "definition": "http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"
        }
      ]
    }
  ]
}