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

FHIR IG analytics

Packagehl7.fhir.be.patient-dossier
Resource TypeStructureDefinition
IdStructureDefinition-be-model-episode-of-care.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/hl7-be/patient-dossier/StructureDefinition-be-model-episode-of-care.html
URLhttps://www.ehealth.fgov.be/standards/fhir/patient-dossier/StructureDefinition/be-model-episode-of-care
Version1.0.0
Statusactive
Date2026-09-30T08:04:14+00:00
NameBeModelEpisodeOfCare
TitleBeEpisodeOfCare model
Realmbe
Authorityhl7
DescriptionLogical model for the EpisodeOfCare CareSet - represents a period during which care related to a specific goal or problem is provided to a patient by one or more healthcare providers and/or organizations.
Typehttps://www.ehealth.fgov.be/standards/fhir/patient-dossier/StructureDefinition/be-model-episode-of-care
Kindlogical

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

Generated Narrative: StructureDefinition be-model-episode-of-care

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-episode-of-care 0..*BaseBeEpisodeOfCare model
Instances of this type can be the target of a Reference
... identifier 1..*IdentifierUnique Business Identifier of the CareSet
... patient 1..1Reference()The person who is the subject of the healthcare to which the record refers (NISS, BIS or other authorised identification)
... recordedDate 1..1dateTimeRecording date by the Author or Recorder (date of last update)
... status 1..1codeCurrent status of the episode
Binding: EpisodeOfCareStatus (required)
... author 1..1Reference()The healthcare professional who takes responsibility for the recorded content
... period 1..1PeriodThe period between the moment the resource is created to group the provided care and the moment it ends
... reason 1..1BackboneElementThe main problem treated during the EpisodeOfCare
.... reference 0..1Reference()The main problem treated during the EpisodeOfCare, as a reference
.... code 0..1CodeableConceptThe main problem treated during the EpisodeOfCare, as a code
Binding: EncounterReasonCodes (extensible)
... note 0..*AnnotationOptional additional remark
... managingOrganization 0..1Reference()Organization responsible for the management and coordination of the patient's EpisodeOfCare
... careTeam 0..*Reference()The care team(s) participating in the EpisodeOfCare

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "be-model-episode-of-care",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    }
  ],
  "url": "https://www.ehealth.fgov.be/standards/fhir/patient-dossier/StructureDefinition/be-model-episode-of-care",
  "version": "1.0.0",
  "name": "BeModelEpisodeOfCare",
  "title": "BeEpisodeOfCare model",
  "status": "active",
  "date": "2026-09-30T08:04:14+00:00",
  "publisher": "eHealth Platform",
  "contact": [
    {
      "name": "eHealth Platform",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ehealth.fgov.be"
        },
        {
          "system": "email",
          "value": "support@be-ehealth-standards.atlassian.net"
        }
      ]
    },
    {
      "name": "Message-Structure",
      "telecom": [
        {
          "system": "email",
          "value": "support@be-ehealth-standards.atlassian.net",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Logical model for the EpisodeOfCare CareSet - represents a period during which care related to a specific goal or problem is provided to a patient by one or more healthcare providers and/or organizations.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "BE",
          "display": "Belgium"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "https://www.ehealth.fgov.be/standards/fhir/patient-dossier/StructureDefinition/be-model-episode-of-care",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "be-model-episode-of-care",
        "path": "be-model-episode-of-care",
        "short": "BeEpisodeOfCare model",
        "definition": "Logical model for the EpisodeOfCare CareSet - represents a period during which care related to a specific goal or problem is provided to a patient by one or more healthcare providers and/or organizations.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false
      },
      {
        "id": "be-model-episode-of-care.identifier",
        "path": "be-model-episode-of-care.identifier",
        "short": "Unique Business Identifier of the CareSet",
        "definition": "Unique Business Identifier of the CareSet",
        "min": 1,
        "max": "*",
        "base": {
          "path": "be-model-episode-of-care.identifier",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.patient",
        "path": "be-model-episode-of-care.patient",
        "short": "The person who is the subject of the healthcare to which the record refers (NISS, BIS or other authorised identification)",
        "definition": "The person who is the subject of the healthcare to which the record refers (NISS, BIS or other authorised identification)",
        "min": 1,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.patient",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.recordedDate",
        "path": "be-model-episode-of-care.recordedDate",
        "short": "Recording date by the Author or Recorder (date of last update)",
        "definition": "Enables CareSet history management via the pair Business Identifier - RecordedDate, which guarantees access to the latest version of the content",
        "min": 1,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.recordedDate",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.status",
        "path": "be-model-episode-of-care.status",
        "short": "Current status of the episode",
        "definition": "planned | active | onhold | finished | cancelled | entered-in-error",
        "min": 1,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.status",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/episode-of-care-status"
        }
      },
      {
        "id": "be-model-episode-of-care.author",
        "path": "be-model-episode-of-care.author",
        "short": "The healthcare professional who takes responsibility for the recorded content",
        "definition": "The healthcare professional who takes responsibility for the recorded content",
        "min": 1,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.author",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.period",
        "path": "be-model-episode-of-care.period",
        "short": "The period between the moment the resource is created to group the provided care and the moment it ends",
        "definition": "The period between the moment the resource is created to group the provided care and the moment it ends",
        "min": 1,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.period",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason",
        "path": "be-model-episode-of-care.reason",
        "short": "The main problem treated during the EpisodeOfCare",
        "definition": "The main problem treated during the EpisodeOfCare",
        "min": 1,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.reason",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "BackboneElement"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.id",
        "path": "be-model-episode-of-care.reason.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.extension",
        "path": "be-model-episode-of-care.reason.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.modifierExtension",
        "path": "be-model-episode-of-care.reason.modifierExtension",
        "short": "Extensions that cannot be ignored even if unrecognized",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
        "alias": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "BackboneElement.modifierExtension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": true,
        "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.reference",
        "path": "be-model-episode-of-care.reason.reference",
        "short": "The main problem treated during the EpisodeOfCare, as a reference",
        "definition": "The main problem treated during the EpisodeOfCare, as a reference",
        "min": 0,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.reason.reference",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.code",
        "path": "be-model-episode-of-care.reason.code",
        "short": "The main problem treated during the EpisodeOfCare, as a code",
        "definition": "The main problem treated during the EpisodeOfCare, as a code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.reason.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason"
        }
      },
      {
        "id": "be-model-episode-of-care.note",
        "path": "be-model-episode-of-care.note",
        "short": "Optional additional remark",
        "definition": "Optional additional remark",
        "min": 0,
        "max": "*",
        "base": {
          "path": "be-model-episode-of-care.note",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Annotation"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.managingOrganization",
        "path": "be-model-episode-of-care.managingOrganization",
        "short": "Organization responsible for the management and coordination of the patient's EpisodeOfCare",
        "definition": "The organization responsible for the management and coordination of the patient's EpisodeOfCare. The responsibility is not shared: there is one responsible organization, or none.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "be-model-episode-of-care.managingOrganization",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.careTeam",
        "path": "be-model-episode-of-care.careTeam",
        "short": "The care team(s) participating in the EpisodeOfCare",
        "definition": "The care team(s) participating in the EpisodeOfCare",
        "min": 0,
        "max": "*",
        "base": {
          "path": "be-model-episode-of-care.careTeam",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "be-model-episode-of-care",
        "path": "be-model-episode-of-care",
        "short": "BeEpisodeOfCare model",
        "definition": "Logical model for the EpisodeOfCare CareSet - represents a period during which care related to a specific goal or problem is provided to a patient by one or more healthcare providers and/or organizations."
      },
      {
        "id": "be-model-episode-of-care.identifier",
        "path": "be-model-episode-of-care.identifier",
        "short": "Unique Business Identifier of the CareSet",
        "definition": "Unique Business Identifier of the CareSet",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.patient",
        "path": "be-model-episode-of-care.patient",
        "short": "The person who is the subject of the healthcare to which the record refers (NISS, BIS or other authorised identification)",
        "definition": "The person who is the subject of the healthcare to which the record refers (NISS, BIS or other authorised identification)",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.recordedDate",
        "path": "be-model-episode-of-care.recordedDate",
        "short": "Recording date by the Author or Recorder (date of last update)",
        "definition": "Enables CareSet history management via the pair Business Identifier - RecordedDate, which guarantees access to the latest version of the content",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.status",
        "path": "be-model-episode-of-care.status",
        "short": "Current status of the episode",
        "definition": "planned | active | onhold | finished | cancelled | entered-in-error",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/episode-of-care-status"
        }
      },
      {
        "id": "be-model-episode-of-care.author",
        "path": "be-model-episode-of-care.author",
        "short": "The healthcare professional who takes responsibility for the recorded content",
        "definition": "The healthcare professional who takes responsibility for the recorded content",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.period",
        "path": "be-model-episode-of-care.period",
        "short": "The period between the moment the resource is created to group the provided care and the moment it ends",
        "definition": "The period between the moment the resource is created to group the provided care and the moment it ends",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason",
        "path": "be-model-episode-of-care.reason",
        "short": "The main problem treated during the EpisodeOfCare",
        "definition": "The main problem treated during the EpisodeOfCare",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.reference",
        "path": "be-model-episode-of-care.reason.reference",
        "short": "The main problem treated during the EpisodeOfCare, as a reference",
        "definition": "The main problem treated during the EpisodeOfCare, as a reference",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.reason.code",
        "path": "be-model-episode-of-care.reason.code",
        "short": "The main problem treated during the EpisodeOfCare, as a code",
        "definition": "The main problem treated during the EpisodeOfCare, as a code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason"
        }
      },
      {
        "id": "be-model-episode-of-care.note",
        "path": "be-model-episode-of-care.note",
        "short": "Optional additional remark",
        "definition": "Optional additional remark",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Annotation"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.managingOrganization",
        "path": "be-model-episode-of-care.managingOrganization",
        "short": "Organization responsible for the management and coordination of the patient's EpisodeOfCare",
        "definition": "The organization responsible for the management and coordination of the patient's EpisodeOfCare. The responsibility is not shared: there is one responsible organization, or none.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "be-model-episode-of-care.careTeam",
        "path": "be-model-episode-of-care.careTeam",
        "short": "The care team(s) participating in the EpisodeOfCare",
        "definition": "The care team(s) participating in the EpisodeOfCare",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference"
          }
        ]
      }
    ]
  }
}