FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.cda.uv.core
Resource TypeStructureDefinition
IdStructureDefinition-ServiceEvent.json
FHIR VersionR5

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

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

This class represents the main Act, such as a colonoscopy or an appendectomy, being documented.

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "History and Physical Report" and the procedure being documented is a "History and Physical" act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply "Procedure Report" and the procedure was a "colonoscopy". If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

ServiceEvent.effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place.


Source1

{
  "resourceType": "StructureDefinition",
  "id": "ServiceEvent",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "not-applicable"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
      "valueUri": "serviceEvent"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent",
  "version": "2.0.1",
  "name": "CDAR2.ServiceEvent",
  "title": "ServiceEvent (CDA Class)",
  "status": "active",
  "experimental": false,
  "date": "2023-10-03T20:44:04+00:00",
  "publisher": "Health Level 7",
  "contact": [
    {
      "name": "HL7 International - Structured Documents",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/structdoc"
        },
        {
          "system": "email",
          "value": "structdog@lists.HL7.org"
        }
      ]
    }
  ],
  "description": "This class represents the main Act, such as a colonoscopy or an appendectomy, being documented.\nIn some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is \"History and Physical Report\" and the procedure being documented is a \"History and Physical\" act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.\nServiceEvent.effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place.",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "ServiceEvent",
        "path": "ServiceEvent",
        "short": "Base for all types and resources",
        "definition": "Base definition for all types defined in FHIR type system.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ServiceEvent.classCode",
        "path": "ServiceEvent.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "ServiceEvent.classCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode": "ACT",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClass"
        }
      },
      {
        "id": "ServiceEvent.moodCode",
        "path": "ServiceEvent.moodCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "ServiceEvent.moodCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "EVN",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
        }
      },
      {
        "id": "ServiceEvent.templateId",
        "path": "ServiceEvent.templateId",
        "definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ServiceEvent.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "ServiceEvent.id",
        "path": "ServiceEvent.id",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ServiceEvent.id",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "ServiceEvent.code",
        "path": "ServiceEvent.code",
        "definition": "Drawn from concept domain ActCode",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ServiceEvent.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ]
      },
      {
        "id": "ServiceEvent.effectiveTime",
        "path": "ServiceEvent.effectiveTime",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ServiceEvent.effectiveTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id": "ServiceEvent.performer",
        "path": "ServiceEvent.performer",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ServiceEvent.performer",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer1"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ServiceEvent",
        "path": "ServiceEvent",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ServiceEvent.classCode",
        "path": "ServiceEvent.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode": "ACT",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClass"
        }
      },
      {
        "id": "ServiceEvent.moodCode",
        "path": "ServiceEvent.moodCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "EVN",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
        }
      },
      {
        "id": "ServiceEvent.templateId",
        "path": "ServiceEvent.templateId",
        "definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "ServiceEvent.id",
        "path": "ServiceEvent.id",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "ServiceEvent.code",
        "path": "ServiceEvent.code",
        "definition": "Drawn from concept domain ActCode",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ]
      },
      {
        "id": "ServiceEvent.effectiveTime",
        "path": "ServiceEvent.effectiveTime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id": "ServiceEvent.performer",
        "path": "ServiceEvent.performer",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer1"
          }
        ]
      }
    ]
  }
}