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

FHIR IG Statistics: CapabilityStatement/eom-mcode-server

Packageglobalalliant.us.eom
TypeCapabilityStatement
Ideom-mcode-server
FHIR VersionR4
Sourcehttps://globalalliantinc.com/enhancing-oncology-model/https://simplifier.net/resolve?scope=globalalliant.us.eom@1.0.1-rc2&canonical=https://globalalliantinc.com/enhancing-oncology-model/CapabilityStatement/eom-mcode-server
URLhttps://globalalliantinc.com/enhancing-oncology-model/CapabilityStatement/eom-mcode-server
Statusdraft
Date2024-01-25T14:55:00.000000-04:00
NameCapabilityStatementEomPatientBundle
TitlemCODE EOM Server: Get Bundle for an EOM Patient
DescriptionEOM example for creating an mCODE-derived capability statement.
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

mCODE EOM Server: Get an EOM Bundle for a Patient

  • Official URL:http://hl7.org/fhir/us/mcode/CapabilityStatement/mcode-sender-patient-bundle
  • Implementation Guide Version: None
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: XML, JSON
  • Published: 2020-10-30 07:15:00.000000-04:00
  • Published by: None
  • Status: Draft (experimental)

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.

Support the Following Implementation Guides:

Include And Support Everything In The Following CapabilityStatements:

FHIR Server RESTful Capabilities

An mCODE EOM Server SHOULD:

  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 EOM 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 SHOULD reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

Summary of Server Wide Operations


Source

{
  "resourceType": "CapabilityStatement",
  "id": "eom-mcode-server",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://globalalliantinc.com/enhancing-oncology-model/CapabilityStatement/eom-mcode-server",
  "name": "CapabilityStatementEomPatientBundle",
  "title": "mCODE EOM Server: Get Bundle for an EOM Patient",
  "status": "draft",
  "experimental": true,
  "date": "2024-01-25T14:55:00.000000-04:00",
  "description": "EOM example for creating an mCODE-derived capability statement.",
  "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 Enhancing Oncology Model (EOM) Server **SHOULD**:\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 EOM Server **SHOULD**:\n\n1. Support xml source formats for all mCODE interactions.",
      "security": {
        "description": "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHOULD** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
      },
      "operation": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "eom-mcode-patient-bundle",
          "definition": "http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"
        }
      ]
    }
  ]
}