IDEA4RC FHIR Implementation Guide
0.1.0 - CI Build 150

IDEA4RC FHIR Implementation Guide, published by IDEA4RC Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/idea4rc/ and changes regularly. See the Directory of published versions

Logical Model: HospitalPatientRecordsI4rc - Detailed Descriptions

Draft as of 2024-11-12

Definitions for the HospitalPatientRecords logical model.

Guidance on how to interpret the contents of this table can be found here

0. HospitalPatientRecords
Definition

Hospital Patient Records

ShortHospital Patient Records
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HospitalPatientRecords.patient
Definition

Patient element containing the data regarding the patient followed by the hospital

ShortPatient
Comments

A patient element data

Control1..1
Typehttp://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Subject
Obligations
    ObligationsActor
    SHALL:handle
    4. HospitalPatientRecords.hospital
    Definition

    Hospital element containing the data regarding the patient followed by the hospital

    ShortHospital
    Comments

    A hospital element data

    Control1..1
    TypeBackboneElement
    Obligations
      ObligationsActor
      SHALL:handle
      6. HospitalPatientRecords.hospital.name
      Definition

      Hospital where the patients is included in the registry

      ShortHospital Name
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Obligations
        ObligationsActor
        SHALL:handle
        8. HospitalPatientRecords.firstContactDate
        Definition

        Date of the first contact of the patient with the hospital registering the data. The hospital will record information on the patient's entire disease trajectory, thus also on procedures and/or treatments performed in another hospital. The ?date of first contact? will be crossed with other dates to better understand which parts of the disease path were managed by the hospital that registered the patient.

        ShortDate of first contact with the hospital
        Comments

        Date

        Control1..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Obligations
          ObligationsActor
          SHALL:handle

          Guidance on how to interpret the contents of this table can be found here

          0. HospitalPatientRecords
          Definition

          Hospital Patient Records

          ShortHospital Patient Records
          Control0..*
          Is Modifierfalse
          Logical ModelInstances of this logical model are not marked to be the target of a Reference
          2. HospitalPatientRecords.patient
          Definition

          Patient element containing the data regarding the patient followed by the hospital

          ShortPatient
          Comments

          A patient element data

          Control1..1
          Typehttp://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Subject
          Obligations
            ObligationsActor
            SHALL:handle
            4. HospitalPatientRecords.hospital
            Definition

            Hospital element containing the data regarding the patient followed by the hospital

            ShortHospital
            Comments

            A hospital element data

            Control1..1
            TypeBackboneElement
            Obligations
              ObligationsActor
              SHALL:handle
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. HospitalPatientRecords.hospital.modifierExtension
              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.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              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.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              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.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              8. HospitalPatientRecords.hospital.name
              Definition

              Hospital where the patients is included in the registry

              ShortHospital Name
              Control1..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Obligations
                ObligationsActor
                SHALL:handle
                10. HospitalPatientRecords.firstContactDate
                Definition

                Date of the first contact of the patient with the hospital registering the data. The hospital will record information on the patient's entire disease trajectory, thus also on procedures and/or treatments performed in another hospital. The ?date of first contact? will be crossed with other dates to better understand which parts of the disease path were managed by the hospital that registered the patient.

                ShortDate of first contact with the hospital
                Comments

                Date

                Control1..1
                Typedate
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Obligations
                  ObligationsActor
                  SHALL:handle

                  Guidance on how to interpret the contents of this table can be found here

                  0. HospitalPatientRecords
                  Definition

                  Hospital Patient Records

                  ShortHospital Patient Records
                  Control0..*
                  Is Modifierfalse
                  Logical ModelInstances of this logical model are not marked to be the target of a Reference
                  2. HospitalPatientRecords.patient
                  Definition

                  Patient element containing the data regarding the patient followed by the hospital

                  ShortPatient
                  Comments

                  A patient element data

                  Control1..1
                  Typehttp://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Subject
                  Obligations
                    ObligationsActor
                    SHALL:handle
                    4. HospitalPatientRecords.hospital
                    Definition

                    Hospital element containing the data regarding the patient followed by the hospital

                    ShortHospital
                    Comments

                    A hospital element data

                    Control1..1
                    TypeBackboneElement
                    Obligations
                      ObligationsActor
                      SHALL:handle
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      6. HospitalPatientRecords.hospital.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      8. HospitalPatientRecords.hospital.extension
                      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.

                      ShortAdditional content defined by implementations
                      Comments

                      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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on HospitalPatientRecords.hospital.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 10. HospitalPatientRecords.hospital.modifierExtension
                        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.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        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.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        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.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        12. HospitalPatientRecords.hospital.name
                        Definition

                        Hospital where the patients is included in the registry

                        ShortHospital Name
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Obligations
                          ObligationsActor
                          SHALL:handle
                          14. HospitalPatientRecords.firstContactDate
                          Definition

                          Date of the first contact of the patient with the hospital registering the data. The hospital will record information on the patient's entire disease trajectory, thus also on procedures and/or treatments performed in another hospital. The ?date of first contact? will be crossed with other dates to better understand which parts of the disease path were managed by the hospital that registered the patient.

                          ShortDate of first contact with the hospital
                          Comments

                          Date

                          Control1..1
                          Typedate
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Obligations
                            ObligationsActor
                            SHALL:handle