XIG: StructureDefinition/EHDSPatient

FHIR IG Statistics: StructureDefinition/EHDSPatient

Package	hl7.fhir.eu.imaging-r5
Type	StructureDefinition
Id	EHDSPatient
FHIR Version	R5
Source	http://hl7.eu/fhir/imaging-r5/https://build.fhir.org/ig/hl7-eu/imaging/StructureDefinition-EHDSPatient.html
URL	https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
Version	0.1.0
Status	draft
Date	2025-03-21T08:17:12+00:00
Name	EHDSPatient
Title	Patient model
Realm	eu
Authority	hl7
Description	C.1 - EHDS refined base model for Patient/subject information
Copyright	Used by permission of HL7 Europe, all rights reserved Creative Commons License
Type	https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
Kind	logical

Resources that use this resource

ConceptMap
EHDSPatientMap	EHDSPatient Mapping
EHDSPatientMap	EHDSPatient Mapping

StructureDefinition
EHDSAllergyIntolerance	Allergy intolerance model
EHDSAppointment	Appointment model
EHDSCarePlan	Care plan model
EHDSClinicalImpression	Clinical impression model
EHDSCommonHeader	Resource header model
EHDSCondition	Condition model
EHDSCoverage	Coverage model
EHDSDeviceUse	Device use model
EHDSEncounter	Encounter model
EHDSEpisodeOfCare	Episode of care model
EHDSFunctionalStatus	Functional status
EHDSHospitalDischargeReportHeader	Hospital Discharge Report header model
EHDSImagingReportHeader	Imaging report header model
EHDSImagingStudy	Imaging study model
EHDSImmunization	Immunization model
EHDSLaboratoryOrderHeader	Laboratory order header model
EHDSLaboratoryReportHeader	Laboratory report header model
EHDSMedia	Media model
EHDSMedicationAdministration	Medication administration model
EHDSMedicationDispense	Medication dispensation model
EHDSObservation	Observation model
EHDSPatientSummaryHeader	Patient summary header model
EHDSProcedure	Procedure model
EHDSReportHeader	Report header model
EHDSServiceRequest	Service request model
EHDSSpecimen	Specimen model
EHDSAdvanceDirective	Advance directive model
EHDSDataSet	DataSet model
EHDSDischargeReport	Discharge Report model
EHDSAllergyIntolerance	Allergy intolerance model
EHDSAppointment	Appointment model
EHDSCarePlan	Care plan model
EHDSClinicalImpression	Clinical impression model
EHDSCommonHeader	Resource header model
EHDSCondition	Condition model
EHDSCoverage	Coverage model
EHDSDeviceUse	Device use model
EHDSEncounter	Encounter model
EHDSEpisodeOfCare	Episode of care model
EHDSFunctionalStatus	Functional status
EHDSHospitalDischargeReportHeader	Hospital Discharge Report header model
EHDSImagingReportHeader	Imaging report header model
EHDSImagingStudy	Imaging study model
EHDSImmunization	Immunization model
EHDSLaboratoryOrderHeader	Laboratory order header model
EHDSLaboratoryReportHeader	Laboratory report header model
EHDSMedia	Media model
EHDSMedicationAdministration	Medication administration model
EHDSMedicationDispense	Medication dispensation model
EHDSObservation	Observation model
EHDSPatientSummaryHeader	Patient summary header model
EHDSProcedure	Procedure model
EHDSReportHeader	Report header model
EHDSServiceRequest	Service request model
EHDSSpecimen	Specimen model

Resources that this resource uses

StructureDefinition
EHDSAddress	Address model
EHDSHumanName	Human name model
EHDSTelecom	Telecom model
EHDSAddress	Address model
EHDSHumanName	Human name model
EHDSTelecom	Telecom model

Narrative

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

Generated Narrative: StructureDefinition EHDSPatient

Name	Card.	Type	Description & Constraints
EHDSPatient		Base	Patient model Instances of this logical model can be the target of a Reference
personalIdentifier	1..*	Identifier	C.1.1 - Personal identifier
name	0..*	EHDSHumanName	C.1.2 - Name
dateOfBirth	0..1	dateTime	C.1.3 - Date of birth
administrativeGender	0..1	CodeableConcept	C.1.4 - Administrative gender Binding Description: (preferred): HL7 Administrative Gender
address	0..*	EHDSAddress	C.1.5 - Address
telecom	0..*	EHDSTelecom	C.1.6 - Telecom
maritalStatus	0..1	CodeableConcept	C.1.7 - Marital status Binding Description: (preferred): HL7 marital-status
citizenship	0..*	CodeableConcept	C.1.8 - Citizenship (nationality) Binding Description: (preferred): ISO 3166-1-2
communicationLanguage	0..*	CodeableConcept	C.1.9 - Communcation language Binding Description: (preferred): BCP 47
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "EHDSPatient",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    }
  ],
  "url": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient",
  "version": "0.1.0",
  "name": "EHDSPatient",
  "title": "Patient model",
  "status": "draft",
  "date": "2025-03-21T08:17:12+00:00",
  "publisher": "HL7 Europe",
  "contact": [
    {
      "name": "Xt-EHR",
      "telecom": [
        {
          "system": "url",
          "value": "http://Xt-EHR.eu"
        }
      ]
    }
  ],
  "description": "C.1 - EHDS refined base model for Patient/subject information",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "150",
          "display": "Europe"
        }
      ]
    }
  ],
  "copyright": "Used by permission of HL7 Europe, all rights reserved Creative Commons License",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "EHDSPatient",
        "path": "EHDSPatient",
        "short": "Patient model",
        "definition": "C.1 - EHDS refined base model for Patient/subject information",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "EHDSPatient.personalIdentifier",
        "path": "EHDSPatient.personalIdentifier",
        "short": "C.1.1 - Personal identifier",
        "definition": "An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) or National patient identifier for the Czech patient. Multiple identifiers could be provided. ",
        "min": 1,
        "max": "*",
        "base": {
          "path": "EHDSPatient.personalIdentifier",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "EHDSPatient.name",
        "path": "EHDSPatient.name",
        "short": "C.1.2 - Name",
        "definition": "Name associated with the patient/subject. Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSPatient.name",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHumanName"
          }
        ]
      },
      {
        "id": "EHDSPatient.dateOfBirth",
        "path": "EHDSPatient.dateOfBirth",
        "short": "C.1.3 - Date of birth",
        "definition": "The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSPatient.dateOfBirth",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "EHDSPatient.administrativeGender",
        "path": "EHDSPatient.administrativeGender",
        "short": "C.1.4 - Administrative gender",
        "definition": "This field must contain a recognized valid value for \"administrative gender\". If different, \"physiological gender\" should be communicated elsewhere. ",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSPatient.administrativeGender",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "HL7 Administrative Gender"
        }
      },
      {
        "id": "EHDSPatient.address",
        "path": "EHDSPatient.address",
        "short": "C.1.5 - Address",
        "definition": "Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSPatient.address",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAddress"
          }
        ]
      },
      {
        "id": "EHDSPatient.telecom",
        "path": "EHDSPatient.telecom",
        "short": "C.1.6 - Telecom",
        "definition": "Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSPatient.telecom",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSTelecom"
          }
        ]
      },
      {
        "id": "EHDSPatient.maritalStatus",
        "path": "EHDSPatient.maritalStatus",
        "short": "C.1.7 - Marital status",
        "definition": "Marital (civil) status of a patient",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSPatient.maritalStatus",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "HL7 marital-status"
        }
      },
      {
        "id": "EHDSPatient.citizenship",
        "path": "EHDSPatient.citizenship",
        "short": "C.1.8 - Citizenship (nationality)",
        "definition": "Citizenship/nationality of the patient.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSPatient.citizenship",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "ISO 3166-1-2"
        }
      },
      {
        "id": "EHDSPatient.communicationLanguage",
        "path": "EHDSPatient.communicationLanguage",
        "short": "C.1.9 - Communcation language",
        "definition": "The language which can be used to communicate with the patient about his or her health.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EHDSPatient.communicationLanguage",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "BCP 47"
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "EHDSPatient",
        "path": "EHDSPatient",
        "short": "Patient model",
        "definition": "C.1 - EHDS refined base model for Patient/subject information"
      },
      {
        "id": "EHDSPatient.personalIdentifier",
        "path": "EHDSPatient.personalIdentifier",
        "short": "C.1.1 - Personal identifier",
        "definition": "An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) or National patient identifier for the Czech patient. Multiple identifiers could be provided. ",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "EHDSPatient.name",
        "path": "EHDSPatient.name",
        "short": "C.1.2 - Name",
        "definition": "Name associated with the patient/subject. Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHumanName"
          }
        ]
      },
      {
        "id": "EHDSPatient.dateOfBirth",
        "path": "EHDSPatient.dateOfBirth",
        "short": "C.1.3 - Date of birth",
        "definition": "The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "EHDSPatient.administrativeGender",
        "path": "EHDSPatient.administrativeGender",
        "short": "C.1.4 - Administrative gender",
        "definition": "This field must contain a recognized valid value for \"administrative gender\". If different, \"physiological gender\" should be communicated elsewhere. ",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "HL7 Administrative Gender"
        }
      },
      {
        "id": "EHDSPatient.address",
        "path": "EHDSPatient.address",
        "short": "C.1.5 - Address",
        "definition": "Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAddress"
          }
        ]
      },
      {
        "id": "EHDSPatient.telecom",
        "path": "EHDSPatient.telecom",
        "short": "C.1.6 - Telecom",
        "definition": "Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSTelecom"
          }
        ]
      },
      {
        "id": "EHDSPatient.maritalStatus",
        "path": "EHDSPatient.maritalStatus",
        "short": "C.1.7 - Marital status",
        "definition": "Marital (civil) status of a patient",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "HL7 marital-status"
        }
      },
      {
        "id": "EHDSPatient.citizenship",
        "path": "EHDSPatient.citizenship",
        "short": "C.1.8 - Citizenship (nationality)",
        "definition": "Citizenship/nationality of the patient.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "ISO 3166-1-2"
        }
      },
      {
        "id": "EHDSPatient.communicationLanguage",
        "path": "EHDSPatient.communicationLanguage",
        "short": "C.1.9 - Communcation language",
        "definition": "The language which can be used to communicate with the patient about his or her health.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "strength": "preferred",
          "description": "BCP 47"
        }
      }
    ]
  }
}