0.1.0 - ci-build

IntegrierteVersorgungDiabetes, published by ELGA GmbH. 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/HL7Austria/ELGA-IV-Diabetes-R4/ and changes regularly. See the Directory of published versions

Logical Model: SubjectIps - Detailed Descriptions

Draft as of 2024-11-11

Definitions for the Subject-ips logical model.

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

0. Subject-ips
Definition

Abbildung der Datenfelder, die für den Entwurf der Datenspezifikation des Rahmenkonzepts Integrierte Versorgung Diabetes Mellitus Typ 2 erforderlich sind, auf dem des IPS-Modul "Subject".

Refer to the mapping from the logical model of diabetes to the logical model based on the International Patient Summary (IPS) in order to get an idea how the IPS relates to diabetes.

ShortSubject (IPS)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Subject-ips.identifier
Definition

An identifier for this subject

ShortAn identifier for this subject
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. Subject-ips.name
Definition

A name associated with the subject

ShortA name associated with the subject
Control1..*
TypeHumanName
6. Subject-ips.telecom
Definition

A contact detail for the subject

ShortA contact detail for the subject
Control1..*
TypeContactPoint
8. Subject-ips.gender
Definition

male | female | other | unknown

Shortmale | female | other | unknown
Control1..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Subject-ips.genderExtension
Definition

Extension in case gender = other

ShortExtension in case gender = other
Control0..1
BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension
(required to https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension)
TypeCodeableConcept
12. Subject-ips.birthDate
Definition

The date of birth for the subject

ShortThe date of birth for the subject
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Subject-ips.address
Definition

An address for the subject

ShortAn address for the subject
Control1..*
TypeAddress
16. Subject-ips.contact
Definition

A contact party (e.g. guardian, partner, friend) for the patient

ShortA contact party (e.g. guardian, partner, friend) for the patient
Control0..*
TypeBackboneElement
18. Subject-ips.contactInsurance
Definition

The insurance company

ShortThe insurance company
Control1..1
TypeBackboneElement
20. Subject-ips.contactInsurance.relationship
Definition

The nature of the relationship between a patient and a contact person for that patient.

ShortThe nature of the relationship between a patient and a contact person for that patient.
Control1..1
BindingThe codes SHALL be taken from PatientContactRelationship
(required to http://hl7.org/fhir/ValueSet/patient-contactrelationship)
TypeCodeableConcept
Fixed Value{
  "coding" : [{
    "system" : "http://terminology.hl7.org/CodeSystem/v2-0131",
    "code" : "I"
  }]
}
22. Subject-ips.generalPractitioner
Definition

Patient's nominated primary care provider

ShortPatient's nominated primary care provider
Control0..*
TypeReference(Organization, Practitioner, PractitionerRole)

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

0. Subject-ips
Definition

Abbildung der Datenfelder, die für den Entwurf der Datenspezifikation des Rahmenkonzepts Integrierte Versorgung Diabetes Mellitus Typ 2 erforderlich sind, auf dem des IPS-Modul "Subject".

Refer to the mapping from the logical model of diabetes to the logical model based on the International Patient Summary (IPS) in order to get an idea how the IPS relates to diabetes.

ShortSubject (IPS)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Subject-ips.identifier
Definition

An identifier for this subject

ShortAn identifier for this subject
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. Subject-ips.name
Definition

A name associated with the subject

ShortA name associated with the subject
Control1..*
TypeHumanName
6. Subject-ips.telecom
Definition

A contact detail for the subject

ShortA contact detail for the subject
Control1..*
TypeContactPoint
8. Subject-ips.gender
Definition

male | female | other | unknown

Shortmale | female | other | unknown
Control1..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Subject-ips.genderExtension
Definition

Extension in case gender = other

ShortExtension in case gender = other
Control0..1
BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension
(required to https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension)
TypeCodeableConcept
12. Subject-ips.birthDate
Definition

The date of birth for the subject

ShortThe date of birth for the subject
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Subject-ips.address
Definition

An address for the subject

ShortAn address for the subject
Control1..*
TypeAddress
16. Subject-ips.contact
Definition

A contact party (e.g. guardian, partner, friend) for the patient

ShortA contact party (e.g. guardian, partner, friend) for the patient
Control0..*
TypeBackboneElement
18. Subject-ips.contactInsurance
Definition

The insurance company

ShortThe insurance company
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Subject-ips.contactInsurance.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())
22. Subject-ips.contactInsurance.relationship
Definition

The nature of the relationship between a patient and a contact person for that patient.

ShortThe nature of the relationship between a patient and a contact person for that patient.
Control1..1
BindingThe codes SHALL be taken from PatientContactRelationship
(required to http://hl7.org/fhir/ValueSet/patient-contactrelationship)
TypeCodeableConcept
Fixed Value{
  "coding" : [{
    "system" : "http://terminology.hl7.org/CodeSystem/v2-0131",
    "code" : "I"
  }]
}
24. Subject-ips.generalPractitioner
Definition

Patient's nominated primary care provider

ShortPatient's nominated primary care provider
Control0..*
TypeReference(Organization, Practitioner, PractitionerRole)

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

0. Subject-ips
Definition

Abbildung der Datenfelder, die für den Entwurf der Datenspezifikation des Rahmenkonzepts Integrierte Versorgung Diabetes Mellitus Typ 2 erforderlich sind, auf dem des IPS-Modul "Subject".

Refer to the mapping from the logical model of diabetes to the logical model based on the International Patient Summary (IPS) in order to get an idea how the IPS relates to diabetes.

ShortSubject (IPS)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Subject-ips.identifier
Definition

An identifier for this subject

ShortAn identifier for this subject
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. Subject-ips.name
Definition

A name associated with the subject

ShortA name associated with the subject
Control1..*
TypeHumanName
6. Subject-ips.telecom
Definition

A contact detail for the subject

ShortA contact detail for the subject
Control1..*
TypeContactPoint
8. Subject-ips.gender
Definition

male | female | other | unknown

Shortmale | female | other | unknown
Control1..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Subject-ips.genderExtension
Definition

Extension in case gender = other

ShortExtension in case gender = other
Control0..1
BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension
(required to https://termgit.elga.gv.at/ValueSet/hl7-at-administrativegender-fhir-extension)
TypeCodeableConcept
12. Subject-ips.birthDate
Definition

The date of birth for the subject

ShortThe date of birth for the subject
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Subject-ips.address
Definition

An address for the subject

ShortAn address for the subject
Control1..*
TypeAddress
16. Subject-ips.contact
Definition

A contact party (e.g. guardian, partner, friend) for the patient

ShortA contact party (e.g. guardian, partner, friend) for the patient
Control0..*
TypeBackboneElement
18. Subject-ips.contactInsurance
Definition

The insurance company

ShortThe insurance company
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Subject-ips.contactInsurance.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
22. Subject-ips.contactInsurance.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 Subject-ips.contactInsurance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 24. Subject-ips.contactInsurance.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())
    26. Subject-ips.contactInsurance.relationship
    Definition

    The nature of the relationship between a patient and a contact person for that patient.

    ShortThe nature of the relationship between a patient and a contact person for that patient.
    Control1..1
    BindingThe codes SHALL be taken from PatientContactRelationship
    (required to http://hl7.org/fhir/ValueSet/patient-contactrelationship)
    TypeCodeableConcept
    Fixed Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0131",
        "code" : "I"
      }]
    }
    28. Subject-ips.generalPractitioner
    Definition

    Patient's nominated primary care provider

    ShortPatient's nominated primary care provider
    Control0..*
    TypeReference(Organization, Practitioner, PractitionerRole)