description: Logical model of the HIQA Draft National Standard for a Patient Summary, draft for public consultation, September 2026. Built only from the element IDs, conformance, cardinality and datatypes published in the draft. Coded values are not specified by HIQA. This is a consultation draft and will change. Not endorsed by HIQA.
package_name: nostalgic-ie.fhir.core
derivation: specialization
name: HIQAPatientSummaryLM
type: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/HIQAPatientSummaryLM
elements:
  pregnancyInformation:
    type: BackboneElement
    short: Section 15. Pregnancy Information
    index: 248
    elements:
      generatedNarrative: {type: string, short: '[PS 15.1] Generated Narrative (Optional 0..1)', index: 249}
      currentPregnancy:
        type: BackboneElement
        short: '[PS 15.2] Current Pregnancy (record entry) (Required 0..*)'
        array: true
        index: 250
        elements:
          dateOfStatus: {type: dateTime, short: '[PS 15.2.1] Date of status (Mandatory 0..1)', index: 251}
          pregnancyStatus: {type: CodeableConcept, short: '[PS 15.2.2] Pregnancy Status (Mandatory 1..1)', index: 252}
          expectedDeliveryDateEdd: {type: dateTime, short: '[PS 15.2.3] Expected delivery date (EDD) (Mandatory 1..1)', index: 253}
          gestationalAge: {type: Quantity, short: '[PS 15.2.4] Gestational age (Mandatory 1..1)', index: 254}
          note: {type: string, short: '[PS 15.2.5] Note (Optional 0..1)', index: 255}
        required: [expectedDeliveryDateEdd, gestationalAge, pregnancyStatus]
      pregnancyHistory:
        type: BackboneElement
        short: '[PS 15.3] Pregnancy History (record entry) (Required 0..*)'
        array: true
        index: 256
        elements:
          endDateOfThePregnancy: {type: dateTime, short: '[PS 15.3.1] End date of the pregnancy (Mandatory 1..1)', index: 257}
          outcomeOfThePregnancy: {type: CodeableConcept, short: '[PS 15.3.2] Outcome of the pregnancy (Mandatory 1..1)', index: 258}
          numberOfFoetusesInSpecificPregnancy: {type: CodeableConcept, short: '[PS 15.3.3] Number of foetuses in specific pregnancy (Mandatory 1..1)', index: 259}
          note: {type: string, short: '[PS 15.3.4] Note (Optional 0..1)', index: 260}
        required: [numberOfFoetusesInSpecificPregnancy, endDateOfThePregnancy, outcomeOfThePregnancy]
  socialContext:
    type: BackboneElement
    short: Section 12. Social Context
    index: 225
    elements:
      generatedNarrative: {type: string, short: '[PS 12.1] Generated Narrative (Optional 0..1)', index: 226}
      livingSituation: {type: string, short: '[PS 12.2] Living situation (Required 0..*)', array: true, index: 227}
      whatMattersToThePatient: {type: string, short: '[PS 12.3] What matters to the patient (Required 0..*)', array: true, index: 228}
      familySituation: {type: string, short: '[PS 12.4] Family situation (Required 0..*)', array: true, index: 229}
      otherDeterminantsOfHealthObservations: {type: string, short: '[PS 12.5] Other determinants of health observations (Required 0..*)', array: true, index: 230}
      note: {type: string, short: '[PS 12.6] Note (Optional 0..1)', index: 231}
  allergiesAndIntolerances:
    type: BackboneElement
    short: Section 5. Allergies and Intolerances
    index: 108
    elements:
      generatedNarrative: {type: string, short: '[PS 5.1] Generated Narrative (Optional 0..1)', index: 109}
      allergiesAndIntolerancesEmptyReason: {type: CodeableConcept, short: '[PS 5.2] Allergies and intolerances empty reason (Required 0..1)', index: 110}
      allergiesAndIntolerances:
        type: BackboneElement
        short: '[PS 5.3] Allergies and intolerances (record entry) (Required 0..*)'
        array: true
        index: 111
        elements:
          allergiesOrIntolerancesStatus: {type: CodeableConcept, short: '[PS 5.3.1] Allergies or intolerances status (Mandatory 1..1)', index: 112}
          causativeAgentOrAllergen: {type: CodeableConcept, short: '[PS 5.3.2] Causative agent or allergen (Mandatory 1..1)', index: 113}
          onsetDate: {type: dateTime, short: '[PS 5.3.3] Onset date (Required 0..1)', index: 114}
          endDate: {type: dateTime, short: '[PS 5.3.4] End date (Required 0..1)', index: 115}
          certainty: {type: CodeableConcept, short: '[PS 5.3.5] Certainty (Optional 0..1)', index: 116}
          note: {type: string, short: '[PS 5.3.6] Note (Optional 0..1)', index: 117}
          reaction:
            type: BackboneElement
            short: '[PS 5.3.7] Reaction (Cluster) (Required 0..*)'
            array: true
            index: 118
            elements:
              allergen: {type: CodeableConcept, short: '[PS 5.3.7.1] Allergen (Mandatory 1..1)', index: 119}
              descriptionOfReaction: {type: string, short: '[PS 5.3.7.2] Description of reaction (Required 0..*)', array: true, index: 120}
              typeOfReaction: {type: CodeableConcept, short: '[PS 5.3.7.3] Type of reaction (Optional 0..1)', index: 121}
              severity: {type: CodeableConcept, short: '[PS 5.3.7.4] Severity (Required 0..1)', index: 122}
              evidence: {type: CodeableConcept, short: '[PS 5.3.7.5] Evidence (Optional 0..1)', index: 123}
              onsetDate: {type: dateTime, short: '[PS 5.3.7.6] Onset date (Optional 0..1)', index: 124}
              note: {type: string, short: '[PS 5.3.7.7] Note (Optional 0..1)', index: 125}
            required: [allergen]
        required: [causativeAgentOrAllergen, allergiesOrIntolerancesStatus]
  medicationInformation:
    type: BackboneElement
    short: Section 6. Medication Information
    index: 126
    elements:
      generatedNarrative: {type: string, short: '[PS 6.1] Generated Narrative (Optional 0..1)', index: 127}
      medicationsPrescribed: {type: CodeableConcept, short: '[PS 6.2] Medications prescribed (empty reason) (Required 0..1)', index: 128}
      medication:
        type: BackboneElement
        short: '[PS 6.3] Medication (record entry) (Required 0..1)'
        index: 129
        elements:
          indicationForMedication:
            type: BackboneElement
            short: '[PS 6.3.5] Indication for medication (cluster) (Optional 0..*)'
            array: true
            index: 136
            elements:
              indicationForMedication: {type: CodeableConcept, short: '[PS 6.3.5.1] Indication for medication (Optional 0..*)', array: true, index: 137}
              indicationForMedicationInTextFormat: {type: string, short: '[PS 6.3.5.2] Indication for medication in text format (Optional 0..1)', index: 138}
          site: {type: CodeableConcept, short: '[PS 6.3.8] Site (Required 0..1)', index: 141}
          frequency:
            type: BackboneElement
            short: '[PS 6.3.10] Frequency (cluster) (Required 0..1)'
            index: 143
            elements:
              frequencyOfAdministration: {type: integer, short: '[PS 6.3.10.1] Frequency of administration (Mandatory 1..1)', index: 144}
              period: {type: Quantity, short: '[PS 6.3.10.2] Period (Mandatory 1..1)', index: 145}
              dayOfTheWeek: {type: CodeableConcept, short: '[PS 6.3.10.3] Day of the week (Optional 0..*)', array: true, index: 146}
              timeOfTheDay: {type: time, short: '[PS 6.3.10.4] Time of the day (Optional 0..*)', array: true, index: 147}
              eventOrTimePeriodForAdministration: {type: CodeableConcept, short: '[PS 6.3.10.5] Event or time period for administration (Optional 0..*)', array: true, index: 148}
            required: [frequencyOfAdministration, period]
          dose: {type: Quantity, short: '[PS 6.3.9] Dose (Mandatory 1..1)', index: 142}
          medicationClassification: {type: CodeableConcept, short: '[PS 6.3.3] Medication Classification (Required 0..*)', array: true, index: 134}
          route: {type: CodeableConcept, short: '[PS 6.3.7] Route (Required 0..1)', index: 140}
          medicationStatus631MedicationStatus:
            type: BackboneElement
            short: '[PS 6.3.1] Medication status (cluster) 6.3.1 Medication status (cluster) (Required 0..1)'
            index: 130
            elements:
              medicationStatus: {type: CodeableConcept, short: '[PS 6.3.1.1] Medication status (Mandatory 1..1)', index: 131}
              medicationStatusReason: {type: CodeableConcept, short: '[PS 6.3.1.2] Medication status reason (Required 0..1)', index: 132}
            required: [medicationStatus]
          additionalInstructions: {type: string, short: '[PS 6.3.11.1] Additional instructions (Required 0..*)', array: true, index: 149}
          medicationName: {type: CodeableConcept, short: '[PS 6.3.4] Medication name (Mandatory 1..1)', index: 135}
          form: {type: CodeableConcept, short: '[PS 6.3.6] Form (Required 0..1)', index: 139}
          medicationIdentifier: {type: string, short: '[PS 6.3.2] Medication identifier (Required 0..1)', index: 133}
        required: [medicationName, dose]
      aidsToCompliance: {type: CodeableConcept, short: '[PS 6.4] Aids to compliance (Optional 0..*)', array: true, index: 150}
      nonPrescribedMedicationSupplements: {type: CodeableConcept, short: '[PS 6.5] Non-prescribed medication/supplements (Optional 0..*)', array: true, index: 151}
      note: {type: string, short: '[PS 6.6] Note (Optional 0..1)', index: 152}
  observationResults:
    type: BackboneElement
    short: Section 8. Observation Results
    index: 171
    elements:
      generatedNarrative: {type: string, short: '[PS 8.1] Generated Narrative (Optional 0..1)', index: 172}
      observationResult:
        type: BackboneElement
        short: '[PS 8.2] Observation result (Record Entry) (Required 0..*)'
        array: true
        index: 173
        elements:
          dateOfObservationResult: {type: dateTime, short: '[PS 8.2.1] Date of observation result (Mandatory 1..1)', index: 174}
          observationRequested: {type: CodeableConcept, short: '[PS 8.2.2] Observation requested (Mandatory 1..1)', index: 175}
          observationStatus: {type: CodeableConcept, short: '[PS 8.2.3] Observation Status (Mandatory 1..1)', index: 176}
          result:
            type: BackboneElement
            short: '[PS 8.2.4] Result (cluster) (Mandatory 1..1)'
            index: 177
            elements:
              resultCodedValue: {type: CodeableConcept, short: '[PS 8.2.4.1] Result coded value (Required 0..1)', index: 178}
              resultValueText: {type: string, short: '[PS 8.2.4.2] Result value text (Required 0..1)', index: 179}
              resultValueQuantity: {type: Quantity, short: '[PS 8.2.4.3] Result value quantity (Required 0..1)', index: 180}
              resultValueRange: {type: Range, short: '[PS 8.2.4.4] Result value range (Required 0..1)', index: 181}
              resultValueRatio: {type: Ratio, short: '[PS 8.2.4.5] Result value ratio (Required 0..1)', index: 182}
        required: [observationRequested, observationStatus, dateOfObservationResult, result]
      note: {type: string, short: '[PS 8.3] Note (Optional 0..1)', index: 183}
  healthPractitionerDetails:
    type: BackboneElement
    short: Section 2. Health Practitioner Details
    index: 54
    elements:
      nameTitle: {type: CodeableConcept, short: '[PS 2.1] Name title (Optional 0..*)', array: true, index: 55}
      forename: {type: string, short: '[PS 2.2] Forename (Mandatory 1..1)', index: 56}
      healthcareFacilityIdentifier: {type: string, short: '[PS 2.8] Healthcare facility identifier (Required 0..1)', index: 66}
      locationIdGln: {type: string, short: '[PS 2.11] Location ID (GLN) (Required 0..1)', index: 79}
      healthcareFacilityAddress:
        type: BackboneElement
        short: '[PS 2.9] Healthcare facility address (cluster) (Mandatory 1..1)'
        index: 67
        elements:
          postcode: {type: string, short: '[PS 2.9.1] Postcode (Mandatory 1..1)', index: 68}
          addressLineS: {type: string, short: '[PS 2.9.2] Address line(s) (Mandatory 1..1)', index: 69}
          suburbTownTownlandLocality: {type: string, short: '[PS 2.9.3] Suburb/Town/ Townland/Locality (Required 0..1)', index: 70}
          districtCounty: {type: CodeableConcept, short: '[PS 2.9.4] District/ County (Mandatory 1..1)', index: 71}
          country: {type: CodeableConcept, short: '[PS 2.9.5] Country (Mandatory 1..1)', index: 72}
        required: [postcode, country, districtCounty, addressLineS]
      surname: {type: string, short: '[PS 2.3] Surname (Mandatory 1..1)', index: 57}
      communicationDetails:
        type: BackboneElement
        short: '[PS 2.10] Communication details (cluster) (Required 0..1)'
        index: 73
        elements:
          telephoneNumber: {type: string, short: '[PS 2.10.1] Telephone number (Required 0..*)', array: true, index: 74}
          emailAddress: {type: string, short: '[PS 2.10.2] Email address (Required 0..*)', array: true, index: 75}
          otherCommunicationDetails:
            type: BackboneElement
            short: '[PS 2.10.3] Other Communication details (cluster) (Optional 0..*)'
            array: true
            index: 76
            elements:
              communicationDetailsType: {type: CodeableConcept, short: '[PS 2.10.3.1] Communication details – Type (Optional 0..*)', array: true, index: 77}
              communicationDetailsValue: {type: string, short: '[PS 2.10.3.2] Communication Details – Value (Optional 0..*)', array: true, index: 78}
      healthPractitionerRoleAndSpeciality:
        type: BackboneElement
        short: '[PS 2.5] Health practitioner role and speciality (cluster) (Mandatory 1..*)'
        array: true
        min: 1
        index: 59
        elements:
          healthPractitionerRole: {type: CodeableConcept, short: '[PS 2.5.1] Health Practitioner role (Required 0..*)', array: true, index: 60}
          healthPractitionerSpecialty: {type: CodeableConcept, short: '[PS 2.5.2] Health practitioner specialty (Required 0..*)', array: true, index: 61}
      healthPractitionerRegistration:
        type: BackboneElement
        short: '[PS 2.6] Health practitioner registration (cluster) (Mandatory 1..1)'
        index: 62
        elements:
          healthProfessionalBodyRegistrationType: {type: CodeableConcept, short: '[PS 2.6.1] Health Professional body registration – type (Mandatory 1..1)', index: 63}
          healthProfessionalBodyRegistrationValue: {type: string, short: '[PS 2.6.2] Health Professional body registration – value (Mandatory 1..1)', index: 64}
        required: [healthProfessionalBodyRegistrationValue, healthProfessionalBodyRegistrationType]
      healthcareFacilityName: {type: string, short: '[PS 2.7] Healthcare facility name (Required 0..1)', index: 65}
      gmsPanelId: {type: string, short: '[PS 2.12] GMS Panel ID (Optional 0..1)', index: 80}
      nameSuffix: {type: CodeableConcept, short: '[PS 2.4] Name suffix (Optional 0..*)', array: true, index: 58}
    required: [surname, healthPractitionerRegistration, healthPractitionerRoleAndSpeciality, healthcareFacilityAddress, forename]
  functionalStatus:
    type: BackboneElement
    short: Section 17. Functional Status
    index: 274
    elements:
      generatedNarrative: {type: string, short: '[PS 17.1] Generated Narrative (Optional 0..1)', index: 275}
      functionalStatus: {type: CodeableConcept, short: '[PS 17.2] Functional status (Required 0..*)', array: true, index: 276}
      conditionRelatedToFunctionalStatus: {type: CodeableConcept, short: '[PS 17.3] Condition related to functional status (Required 0..*)', array: true, index: 277}
      functionalAssessment:
        type: BackboneElement
        short: '[PS 17.4] Functional Assessment (record entry) (Required 0..*)'
        array: true
        index: 278
        elements:
          dateOfFunctionalAssessment: {type: dateTime, short: '[PS 17.4.1] Date of functional assessment (Mandatory 1..1)', index: 279}
          functionalAssessmentType: {type: CodeableConcept, short: '[PS 17.4.2] Functional assessment type (Mandatory 1..1)', index: 280}
          functionalAssessmentResult:
            type: BackboneElement
            short: '[PS 17.4.3] Functional Assessment Result (cluster) (Mandatory 1..1)'
            index: 281
            elements:
              resultValueCode: {type: CodeableConcept, short: '[PS 17.4.3.1] Result value code (Required 0..1)', index: 282}
              resultValueText: {type: string, short: '[PS 17.4.3.2] Result value text (Required 0..1)', index: 283}
              resultValueQuantity: {type: Quantity, short: '[PS 17.4.3.3] Result value quantity (Required 0..1)', index: 284}
              resultValueRange: {type: Range, short: '[PS 17.4.3.4] Result value range (Required 0..1)', index: 285}
              resultValueRatio: {type: Ratio, short: '[PS 17.4.3.5] Result value ratio (Required 0..1)', index: 286}
        required: [functionalAssessmentType, functionalAssessmentResult, dateOfFunctionalAssessment]
      note: {type: string, short: '[PS 17.5] Note (Optional 0..1)', index: 287}
  patientProvidedData:
    type: BackboneElement
    short: Section 11. Patient Provided Data
    index: 222
    elements:
      patientStory: {type: string, short: '[PS 11.1] Patient story (Optional 0..*)', array: true, index: 223}
      note: {type: string, short: '[PS 11.2] Note (Optional 0..1)', index: 224}
  travelHistory:
    type: BackboneElement
    short: Section 14. Travel History
    index: 239
    elements:
      generatedNarrative: {type: string, short: '[PS 14.1] Generated Narrative (Optional 0..1)', index: 240}
      travelAndCommunicableDiseaseHistory:
        type: BackboneElement
        short: '[PS 14.2] Travel and communicable disease history (record entry) (Required 0..*)'
        array: true
        index: 241
        elements:
          infectiousAgent: {type: CodeableConcept, short: '[PS 14.2.1] Infectious agent (Required 0..*)', array: true, index: 242}
          timePeriod: {type: Period, short: '[PS 14.2.2] Time period (Required 0..*)', array: true, index: 243}
          countryVisited: {type: CodeableConcept, short: '[PS 14.2.3] Country visited (Mandatory 1..*)', array: true, min: 1, index: 244}
          proximity: {type: string, short: '[PS 14.2.4] Proximity (Optional 0..*)', array: true, index: 245}
          currentInfectionControlStatus: {type: CodeableConcept, short: '[PS 14.2.5] Current Infection control status (Required 0..*)', array: true, index: 246}
        required: [countryVisited]
      note: {type: string, short: '[PS 14.3] Note (Optional 0..1)', index: 247}
  immunisationInformation:
    type: BackboneElement
    short: Section 16. Immunisation Information
    index: 261
    elements:
      generatedNarrative: {type: string, short: '[PS 16.1] Generated Narrative (Optional 0..1)', index: 262}
      immunisationsAdministeredEmptyReason: {type: CodeableConcept, short: '[PS 16.2] Immunisations administered empty reason (Required 1..1)', index: 263}
      immunisations:
        type: BackboneElement
        short: '[PS 16.3] Immunisations (record entry) (Required 0..*)'
        array: true
        index: 264
        elements:
          immunisationStatus: {type: CodeableConcept, short: '[PS 16.3.1] Immunisation status (Mandatory 1..1)', index: 265}
          dateAndTimeOfImmunisation: {type: dateTime, short: '[PS 16.3.2] Date and time of Immunisation (Mandatory 1..1)', index: 266}
          administeredProduct: {type: CodeableConcept, short: '[PS 16.3.3] Administered product (Mandatory 1..1)', index: 267}
          targetDiseaseOfImmunisation: {type: CodeableConcept, short: '[PS 16.3.4] Target disease of immunisation (Required 0..*)', array: true, index: 268}
          vaccineCode: {type: CodeableConcept, short: '[PS 16.3.5] Vaccine code (Mandatory 1..1)', index: 269}
          numberOfDoses: {type: CodeableConcept, short: '[PS 16.3.6] Number of doses (Required 0..1)', index: 270}
          immunisationAdministrator:
            short: '[PS 16.3.7] Immunisation administrator (Required 0..1)'
            refers: ['http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
            type: Reference
            index: 271
          administeringCentre:
            short: '[PS 16.3.8] Administering Centre (Required 0..1)'
            refers: ['http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Organization']
            type: Reference
            index: 272
        required: [vaccineCode, dateAndTimeOfImmunisation, immunisationStatus, administeredProduct]
      note: {type: string, short: '[PS 16.4] Note (Optional 0..1)', index: 273}
    required: [immunisationsAdministeredEmptyReason]
  healthConditions:
    type: BackboneElement
    short: Section 7. Health Conditions
    index: 153
    elements:
      generatedNarrative: {type: string, short: '[PS 7.1] Generated Narrative (Optional 0..1)', index: 154}
      healthCondition: {type: CodeableConcept, short: '[PS 7.2] Health condition (empty reason) (Required 0..1)', index: 155}
      healthCondition2:
        type: BackboneElement
        short: '[PS 7.3] Health condition (record entry) (Required 0..*)'
        array: true
        index: 156
        elements:
          diagnosisAssertionStatus: {type: CodeableConcept, short: '[PS 7.3.10] Diagnosis assertion status (Optional 0..1)', index: 166}
          clinicalStageGrade: {type: CodeableConcept, short: '[PS 7.3.9] Clinical stage/grade (Required 0..1)', index: 165}
          healthConditionStatus: {type: CodeableConcept, short: '[PS 7.3.2] Health condition status (Mandatory 1..1)', index: 158}
          anatomicalLocation: {type: CodeableConcept, short: '[PS 7.3.8] Anatomical location (Required 0..*)', array: true, index: 164}
          dateOfDiagnosis: {type: dateTime, short: '[PS 7.3.3] Date of diagnosis (Required 0..1)', index: 159}
          resolutionCircumstances: {type: CodeableConcept, short: '[PS 7.3.11] Resolution circumstances (Optional 0..1)', index: 167}
          endDate: {type: dateTime, short: '[PS 7.3.5] End date (Required 0..1)', index: 161}
          specialistContactDetails: {type: string, short: '[PS 7.3.12] Specialist Contact details (Required 0..*)', array: true, index: 168}
          severity: {type: CodeableConcept, short: '[PS 7.3.7] Severity (Required 0..1)', index: 163}
          problemsHealthCondition: {type: CodeableConcept, short: '[PS 7.3.1] Problems /Health condition (Mandatory 1..1)', index: 157}
          categoryOfProblemConditionOrDiagnosis: {type: CodeableConcept, short: '[PS 7.3.6] Category of problem, condition or diagnosis (Optional 0..*)', array: true, index: 162}
          onsetDate: {type: dateTime, short: '[PS 7.3.4] Onset date (Required 0..1)', index: 160}
          attachment: {type: Attachment, short: '[PS 7.3.13] Attachment (Required 0..*)', array: true, index: 169}
        required: [problemsHealthCondition, healthConditionStatus]
      note: {type: string, short: '[PS 7.4] Note (Optional 0..1)', index: 170}
  patientDetails:
    type: BackboneElement
    short: Section 1. Patient Details
    index: 0
    elements:
      nameDetails:
        type: BackboneElement
        short: 1.1 Name Details
        index: 1
        elements:
          nameTitle: {type: CodeableConcept, short: '[PS 1.1.1] Name title (Optional 0..*)', array: true, index: 2}
          forename: {type: string, short: '[PS 1.1.2] Forename (Mandatory 1..1)', index: 3}
          middleNameS: {type: string, short: '[PS 1.1.3] Middle name (s) (Required 0..1)', index: 4}
          surname: {type: string, short: '[PS 1.1.4] Surname (Mandatory 1..1)', index: 5}
          nameSuffix: {type: CodeableConcept, short: '[PS 1.1.5] Name suffix (Optional 0..*)', array: true, index: 6}
          formerNames: {type: string, short: '[PS 1.1.6] Former names (Required 0..*)', array: true, index: 7}
          preferredName: {type: string, short: '[PS 1.1.7] Preferred name (Required 0..1)', index: 8}
        required: [surname, forename]
      address:
        type: BackboneElement
        short: 1.2 Address
        index: 9
        elements:
          postcode: {type: string, short: '[PS 1.2.1] Postcode (Required 0..1)', index: 10}
          addressLineS: {type: string, short: '[PS 1.2.2] Address line(s) (Mandatory 1..1)', index: 11}
          suburbTownTownlandLocality: {type: string, short: '[PS 1.2.3] Suburb/ Town/ Townland/ Locality (Required 0..1)', index: 12}
          districtCounty: {type: CodeableConcept, short: '[PS 1.2.4] District/ County (Mandatory 1..1)', index: 13}
          country: {type: CodeableConcept, short: '[PS 1.2.5] Country (Required 0..1)', index: 14}
          addressType: {type: CodeableConcept, short: '[PS 1.2.6] Address type (Mandatory 1..1)', index: 15}
          addressUse: {type: CodeableConcept, short: '[PS 1.2.7] Address use (Optional 0..1)', index: 16}
        required: [districtCounty, addressLineS, addressType]
      identifiers:
        type: BackboneElement
        short: 1.3 Identifiers used in Health and Social Care
        index: 17
        elements:
          individualHealthIdentifierIhi: {type: string, short: '[PS 1.3.1] Individual Health Identifier (IHI) (Required 0..1)', index: 18}
          personalPublicServiceNumber: {type: string, short: '[PS 1.3.2] Personal Public Service Number (Required 0..1)', index: 19}
          otherIdentifiersUsedInHealthAndSocialCareDetails:
            type: BackboneElement
            short: '[PS 1.3.3] Other identifiers used in health and social care details (cluster) (Required 0..*)'
            array: true
            index: 20
            elements:
              otherIdentifiersUsedInHealthAndSocialCareType: {type: CodeableConcept, short: '[PS 1.3.3.1] Other identifiers used in health and social care – type (Required 0..1)', index: 21}
              otherIdentifiersUsedInHealthAndSocialCareValue: {type: string, short: '[PS 1.3.3.2] Other identifiers used in health and social care- value (Required 0..1)', index: 22}
              otherIdentifierUsedInHealthAndSocialCareTimePeri: {type: Period, short: '[PS 1.3.3.3] Other identifier used in health and social care - time period (Required 0..1)', index: 23}
              organisationWhoIssuedTheOtherIdentifierUsedInHea: {type: string, short: '[PS 1.3.3.4] Organisation who issued the other identifier used in health and social care (Required 0..1)', index: 24}
          healthInsuranceInformation:
            type: BackboneElement
            short: '[PS 1.3.4] Health insurance information (cluster) (Required 0..*)'
            array: true
            index: 25
            elements:
              healthInsuranceType: {type: CodeableConcept, short: '[PS 1.3.4.1] Health insurance- type (Required 0..1)', index: 26}
              healthInsuranceValue: {type: string, short: '[PS 1.3.4.2] Health insurance- value (Required 0..1)', index: 27}
              nameOfOrganisationProvidingHealthInsurance: {type: CodeableConcept, short: '[PS 1.3.4.3] Name of organisation providing health insurance (Required 0..1)', index: 28}
      additionalDemographicDetails:
        type: BackboneElement
        short: 1.4 Additional Demographic Details
        index: 29
        elements:
          countryOfAffiliation: {type: CodeableConcept, short: '[PS 1.4.8] Country of affiliation (Required 0..1)', index: 41}
          causeOfDeath: {type: CodeableConcept, short: '[PS 1.4.12] Cause of death (Required 0..1)', index: 45}
          sex: {type: CodeableConcept, short: '[PS 1.4.4] Sex (Mandatory 1..1)', index: 35}
          nationality: {type: CodeableConcept, short: '[PS 1.4.7] Nationality (Required 0..*)', array: true, index: 40}
          ethnicity: {type: CodeableConcept, short: '[PS 1.4.10] Ethnicity (Required 0..*)', array: true, index: 43}
          placeOfBirth: {type: CodeableConcept, short: '[PS 1.4.3] Place of birth (Required 0..1)', index: 34}
          preferredLanguage: {type: CodeableConcept, short: '[PS 1.4.9] Preferred language (Optional 0..*)', array: true, index: 42}
          dateOfBirth: {type: dateTime, short: '[PS 1.4.1] Date of birth (Mandatory 1..1)', index: 30}
          dateOfDeath: {type: dateTime, short: '[PS 1.4.11] Date of death (Required 0..1)', index: 44}
          gender:
            type: BackboneElement
            short: '[PS 1.4.5] Gender (cluster) (Required 0..1)'
            index: 36
            elements:
              gender: {type: CodeableConcept, short: '[PS 1.4.5.1] Gender (Required 0..1)', index: 37}
              otherGenderIdentity: {type: string, short: '[PS 1.4.5.2] Other gender identity (Optional 0..1)', index: 38}
          motherSFormerSurnames: {type: string, short: '[PS 1.4.6] Mother''s former surnames (Required 0..*)', array: true, index: 39}
          estimatedAge:
            type: BackboneElement
            short: '[PS 1.4.2] Estimated age (cluster) (Optional 0..1)'
            index: 31
            elements:
              estimatedAgeValue: {type: string, short: '[PS 1.4.2.1] Estimated age - value (Optional 0..1)', index: 32}
              estimatedAgeType: {type: CodeableConcept, short: '[PS 1.4.2.2] Estimated age - type (Optional 0..1)', index: 33}
        required: [dateOfBirth, sex]
      communicationDetails:
        type: BackboneElement
        short: 1.5 Communication Details
        index: 46
        elements:
          mobilePhoneNumber: {type: string, short: '[PS 1.5.1] Mobile phone number (Required 0..*)', array: true, index: 47}
          emailAddress: {type: string, short: '[PS 1.5.2] Email address (Required 0..*)', array: true, index: 48}
          otherCommunicationDetails:
            type: BackboneElement
            short: '[PS 1.5.3] Other communication details (cluster) (Optional 0..*)'
            array: true
            index: 49
            elements:
              otherCommunicationDetailsType: {type: CodeableConcept, short: '[PS 1.5.3.1] Other communication details - type (Optional 0..*)', array: true, index: 50}
              otherCommunicationDetailsValue: {type: string, short: '[PS 1.5.3.2] Other communication details - value (Optional 0..*)', array: true, index: 51}
              otherCommunicationDetailsUse: {type: CodeableConcept, short: '[PS 1.5.3.3] Other communication details - use (Optional 0..*)', array: true, index: 52}
          preferredCommunicationMethod: {type: CodeableConcept, short: '[PS 1.5.4] Preferred communication method (Required 0..*)', array: true, index: 53}
  medicalDevicesImplants:
    type: BackboneElement
    short: Section 10. Medical Devices/Implants
    index: 204
    elements:
      generatedNarrative: {type: string, short: '[PS 10.1] Generated Narrative (Optional 0..1)', index: 205}
      medicalDevicesOrImplants: {type: CodeableConcept, short: '[PS 10.2] Medical devices or implants (empty reason) (Required 0..1)', index: 206}
      medicalDevicesOrImplants2:
        type: BackboneElement
        short: '[PS 10.3] Medical devices or implants (record entry) (Required 0..*)'
        array: true
        index: 207
        elements:
          deviceImplantPeriodOfUse: {type: Period, short: '[PS 10.3.1] Device/ implant period of use (Required 0..1)', index: 208}
          deviceStatus: {type: CodeableConcept, short: '[PS 10.3.2] Device status (Mandatory 1..1)', index: 209}
          deviceName:
            type: BackboneElement
            short: '[PS 10.3.3] Device name (cluster) (Required 0..1)'
            index: 210
            elements:
              deviceNameType: {type: CodeableConcept, short: '[PS 10.3.3.1] Device name type (Mandatory 1..1)', index: 211}
              deviceNameValue: {type: CodeableConcept, short: '[PS 10.3.3.2] Device name value (Mandatory 1..1)', index: 212}
              bodySite:
                type: BackboneElement
                short: '[PS 10.3.3.3] Body site (cluster) (Required 0..1)'
                index: 213
                elements:
                  morphology: {type: CodeableConcept, short: '[PS 10.3.3.3.1] Morphology (Required 0..1)', index: 214}
                  bodySiteLocation: {type: CodeableConcept, short: '[PS 10.3.3.3.2] Body site location (Required 0..1)', index: 215}
                  bodySiteLocationQualifier: {type: CodeableConcept, short: '[PS 10.3.3.3.3] Body site location qualifier (Required 0..1)', index: 216}
                  laterality: {type: CodeableConcept, short: '[PS 10.3.3.3.4] Laterality (Required 0..1)', index: 217}
                  descriptionInTextFormat: {type: string, short: '[PS 10.3.3.3.5] Description in text format (Optional 0..1)', index: 218}
            required: [deviceNameType, deviceNameValue]
        required: [deviceStatus]
      reasonForDeviceImplantInsertionOrRemoval: {type: CodeableConcept, short: '[PS 10.4] Reason for device/implant insertion or removal (Required 0..1)', index: 219}
      attachment: {type: Attachment, short: '[PS 10.5] Attachment (Required 0..*)', array: true, index: 220}
      note: {type: string, short: '[PS 10.6] Note (Optional 0..1)', index: 221}
  advanceHealthcareDirective:
    type: BackboneElement
    short: Section 13. Advance Healthcare Directive
    index: 232
    elements:
      generatedNarrative: {type: string, short: '[PS 13.1] Generated Narrative (Optional 0..1)', index: 233}
      advanceHealthcareDirective: {type: CodeableConcept, short: '[PS 13.2] Advance Healthcare Directive (empty reason) (Required 0..1)', index: 234}
      advanceHealthcareDirectiveAhd:
        type: BackboneElement
        short: '[PS 13.3] Advance Healthcare Directive (AHD) (record entry) (Required 0..*)'
        array: true
        index: 235
        elements:
          categoryOfAhd: {type: CodeableConcept, short: '[PS 13.3.1] Category of AHD (Required 0..*)', array: true, index: 236}
          attachment: {type: Attachment, short: '[PS 13.3.2] Attachment (Mandatory 0..1)', index: 237}
      note: {type: string, short: '[PS 13.4] Note (Optional 0..1)', index: 238}
  procedures:
    type: BackboneElement
    short: Section 9. Procedures, Operations and Treatments
    index: 184
    elements:
      generatedNarrative: {type: string, short: '[PS 9.1] Generated Narrative (Optional 0..1)', index: 185}
      proceduresOperationsOrTreatment: {type: CodeableConcept, short: '[PS 9.2] Procedures, operations or treatment (Empty reason) (Required 0..1)', index: 186}
      proceduresOperationsOrTreatment2:
        type: BackboneElement
        short: '[PS 9.3] Procedures, operations or treatment (record entry) (Required 0..*)'
        array: true
        index: 187
        elements:
          dateOfProcedureOperationOrTreatment: {type: dateTime, short: '[PS 9.3.1] Date of procedure, operation or treatment (Required 0..1)', index: 188}
          procedureOperationOrTreatmentName: {type: CodeableConcept, short: '[PS 9.3.2] Procedure, operation or treatment name (Mandatory 1..1)', index: 189}
          reasonForProcedureOperationOrTreatment: {type: CodeableConcept, short: '[PS 9.3.3] Reason for procedure, operation or treatment (Required 0..*)', array: true, index: 190}
          status: {type: CodeableConcept, short: '[PS 9.3.4] Status (Mandatory 1..1)', index: 191}
          anatomicalLocation:
            type: BackboneElement
            short: '[PS 9.3.5] Anatomical location (cluster) (Required 0..*)'
            array: true
            index: 192
            elements:
              morphology: {type: CodeableConcept, short: '[PS 9.3.5.1] Morphology (Optional 0..1)', index: 193}
              location: {type: CodeableConcept, short: '[PS 9.3.5.2] Location (Required 0..1)', index: 194}
              locationQualifier: {type: CodeableConcept, short: '[PS 9.3.5.3] Location qualifier (Optional 0..*)', array: true, index: 195}
              laterality: {type: CodeableConcept, short: '[PS 9.3.5.4] Laterality (Required 0..1)', index: 196}
              descriptionOfAnatomicalLocation: {type: string, short: '[PS 9.3.5.5] Description of anatomical location (Optional 0..1)', index: 197}
          outcomeOfProcedureOperationOrTreatment: {type: CodeableConcept, short: '[PS 9.3.6] Outcome of procedure, operation or treatment (Optional 0..1)', index: 198}
          complicationsRelatingToProcedureOperationOrTreat: {type: CodeableConcept, short: '[PS 9.3.7] Complications relating to procedure, operation or treatment (Required 0..*)', array: true, index: 199}
          deviceUse:
            type: BackboneElement
            short: '[PS 9.3.8] Device use (cluster) (Optional 0..1)'
            index: 200
            elements:
              deviceUsed: {type: CodeableConcept, short: '[PS 9.3.8.1] Device used (Optional 0..*)', array: true, index: 201}
              focalDevice: {type: CodeableConcept, short: '[PS 9.3.8.2] Focal device (Optional 0..*)', array: true, index: 202}
        required: [procedureOperationOrTreatmentName, status]
      note: {type: string, short: '[PS 9.4] Note (Optional 0..1)', index: 203}
  alerts:
    type: BackboneElement
    short: Section 4. Alerts
    index: 97
    elements:
      generatedNarrative: {type: string, short: '[PS 4.1] Generated Narrative (Optional 0..1)', index: 98}
      alertsEmptyReason: {type: CodeableConcept, short: '[PS 4.2] Alerts empty reason (Required 0..1)', index: 99}
      alerts:
        type: BackboneElement
        short: '[PS 4.3] Alerts (record entry) (Required 0..*)'
        array: true
        index: 100
        elements:
          timePeriodOfAlert: {type: Period, short: '[PS 4.3.1] Time period of alert (Required 0..1)', index: 101}
          alertStatus: {type: CodeableConcept, short: '[PS 4.3.2] Alert status (Mandatory 1..1)', index: 102}
          alert: {type: CodeableConcept, short: '[PS 4.3.3] Alert (Optional 0..1)', index: 103}
          descriptionOfAlert: {type: string, short: '[PS 4.3.4] Description of alert (Required 0..1)', index: 104}
          alertPriority: {type: CodeableConcept, short: '[PS 4.3.5] Alert priority (Optional 0..1)', index: 105}
        required: [alertStatus]
      sourceOfAlertInformation: {type: CodeableConcept, short: '[PS 4.4.6] Source of alert information (Optional 0..*)', array: true, index: 106}
      note: {type: string, short: '[PS 4.5] Note (Optional 0..1)', index: 107}
  carePlan:
    type: BackboneElement
    short: Section 18. Care Plan
    index: 288
    elements:
      generatedNarrative: {type: string, short: '[PS 18.1] Generated Narrative (Optional 0..1)', index: 289}
      carePlan:
        type: BackboneElement
        short: '[PS 18.2] Care Plan (record entry) (Required 0..1)'
        index: 290
        elements:
          nameOfCarePlan: {type: CodeableConcept, short: '[PS 18.2.1] Name of care plan (Required 0..1)', index: 291}
          descriptionOfTheCarePlan: {type: string, short: '[PS 18.2.2] Description of the care plan (Required 0..*)', array: true, index: 292}
          carePlanPeriod: {type: Period, short: '[PS 18.2.3] Care plan period (Optional 0..1)', index: 293}
          conditionRelatedToTheCarePlan: {type: CodeableConcept, short: '[PS 18.2.4] Condition related to the care plan (Optional 0..*)', array: true, index: 294}
          carePlanActivity1825CarePlanActivity:
            type: BackboneElement
            short: '[PS 18.2.5] Care plan activity (cluster) 18.2.5 Care plan activity (cluster) (Optional 0..*)'
            array: true
            index: 295
            elements:
              carePlanActivityType: {type: CodeableConcept, short: '[PS 18.2.5.1] Care plan activity type (Optional 0..*)', array: true, index: 296}
              carePlanSpecificActivity: {type: string, short: '[PS 18.2.5.2] Care plan specific activity (Optional 0..*)', array: true, index: 297}
          carePlanGoal: {type: CodeableConcept, short: '[PS 18.2.6] Care plan goal (Optional 0..*)', array: true, index: 298}
      educationAdviceAndRecommendationsForPatient: {type: string, short: '[PS 18.3] Education, advice and recommendations for patient (Optional 0..*)', array: true, index: 299}
      patientHomeSupportsIdentified: {type: string, short: '[PS 18.4] Patient home supports identified (Required 0..*)', array: true, index: 300}
      patientConcernsExpectationsAndWishes: {type: string, short: '[PS 18.5] Patient concerns, expectations and wishes (Optional 0..*)', array: true, index: 301}
      note: {type: string, short: '[PS 18.6] Note (Optional 0..1)', index: 302}
  nominatedContactPerson:
    type: BackboneElement
    short: Section 3. Nominated Contact Person
    index: 81
    elements:
      forenameOfNominatedContactPerson: {type: string, short: '[PS 3.1] Forename of nominated contact person (Required 0..1)', index: 82}
      surnameOfNominatedContactPerson: {type: string, short: '[PS 3.2] Surname of nominated contact person (Required 0..1)', index: 83}
      roleOfTheNominatedContactPerson: {type: CodeableConcept, short: '[PS 3.3] Role of the nominated contact person (Required 0..*)', array: true, index: 84}
      relationship: {type: CodeableConcept, short: '[PS 3.4] Relationship (Required 0..1)', index: 85}
      communicationDetailsOfNominatedContactPerson:
        type: BackboneElement
        short: '[PS 3.5] Communication details of nominated contact person (cluster) (Required 0..1)'
        index: 86
        elements:
          mobilePhoneNumberOfNominatedContactPerson: {type: string, short: '[PS 3.5.1] Mobile phone number of nominated contact person (Required 0..1)', index: 87}
          landlinePhoneNumberOfNominatedContactPerson: {type: string, short: '[PS 3.5.2] Landline phone number of nominated contact person (Required 0..1)', index: 88}
          emailAddressOfNominatedContactPerson: {type: string, short: '[PS 3.5.3] Email address of nominated contact person (Required 0..1)', index: 89}
      addressOfNominatedContactPerson:
        type: BackboneElement
        short: '[PS 3.6] Address of nominated contact person (cluster) (Optional 0..1)'
        index: 90
        elements:
          postcode: {type: string, short: '[PS 3.6.1] Postcode (Required 0..1)', index: 91}
          addressLineS: {type: string, short: '[PS 3.6.2] Address line(s) (Mandatory 1..1)', index: 92}
          suburbTownTownlandLocality: {type: string, short: '[PS 3.6.3] Suburb/ Town/ Townland/ Locality (Required 0..1)', index: 93}
          districtCountyCityIfOutsideIreland: {type: CodeableConcept, short: '[PS 3.6.4] District/ County/ City (if outside Ireland). (Mandatory 1..1)', index: 94}
          country: {type: CodeableConcept, short: '[PS 3.6.5] Country (Required 0..1)', index: 95}
        required: [addressLineS, districtCountyCityIfOutsideIreland]
      preferredCommunicationTypeForNominatedContactPer: {type: CodeableConcept, short: '[PS 3.7] Preferred communication type for nominated contact person (Required 0..1)', index: 96}
  documentInformation:
    type: BackboneElement
    short: Group 3. Document Information (Section 19)
    index: 303
    elements:
      documentProvenanceData:
        type: BackboneElement
        short: Section 19.1 Document Provenance Data
        index: 304
        elements:
          documentDate: {type: dateTime, short: '[PS 19.1.4] Document date (Mandatory 1..1)', index: 308}
          eventType: {type: CodeableConcept, short: '[PS 19.1.13] Event type (Optional 0..*)', array: true, index: 321}
          legalAuthentication:
            type: BackboneElement
            short: '[PS 19.1.12] Legal authentication (Cluster) (Optional 0..*)'
            array: true
            index: 318
            elements:
              legalAuthenticator:
                short: '[PS 19.1.12.1] Legal authenticator (Mandatory 0..1)'
                refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
                type: Reference
                index: 319
              authenticationDateAndTime: {type: dateTime, short: '[PS 19.1.12.2] Authentication date and time (Mandatory 0..1)', index: 320}
          documentPeriod: {type: Period, short: '[PS 19.1.9] Document period (Optional 0..1)', index: 313}
          documentIdentifier: {type: string, short: '[PS 19.1.2] Document identifier (Mandatory 1..*)', array: true, min: 1, index: 306}
          documentStatus: {type: CodeableConcept, short: '[PS 19.1.5] Document status (Mandatory 1..1)', index: 309}
          documentLanguage: {type: CodeableConcept, short: '[PS 19.1.6] Document language (Optional 0..1)', index: 310}
          documentType: {type: CodeableConcept, short: '[PS 19.1.7] Document type (Mandatory 1..1)', index: 311}
          documentTitle: {type: string, short: '[PS 19.1.8] Document title (Mandatory 1..1)', index: 312}
          custodian:
            short: '[PS 19.1.15] Custodian (Optional 0..1)'
            refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
            type: Reference
            index: 323
          attestation:
            type: BackboneElement
            short: '[PS 19.1.11] Attestation (Cluster) (Optional 0..*)'
            array: true
            index: 315
            elements:
              attester:
                short: '[PS 19.1.11.1] Attester (Mandatory 1..1)'
                refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
                type: Reference
                index: 316
              attestationDateAndTime: {type: dateTime, short: '[PS 19.1.11.2] Attestation date and time (Mandatory 1..1)', index: 317}
            required: [attestationDateAndTime, attester]
          documentAuthor:
            min: 1
            short: '[PS 19.1.3] Document author (Mandatory 1..*)'
            refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
            type: Reference
            array: true
            index: 307
          documentSubjectPatient:
            short: '[PS 19.1.1] Document subject (Patient) (Mandatory 1..1)'
            elementReference: ['https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/HIQAPatientSummaryLM', elements, github, elements, io/ie-core/fhir/ie/core/StructureDefinition/HIQAPatientSummaryLM#HIQAPatientSummaryLM, elements, patientDetails]
            index: 305
          version: {type: string, short: '[PS 19.1.10] Version (Optional 0..1)', index: 314}
          serviceSpeciality: {type: CodeableConcept, short: '[PS 19.1.14] Service speciality (Optional 0..*)', array: true, index: 322}
          attachment: {type: Attachment, short: '[PS 19.1.16] Attachment (Optional 0..*)', array: true, index: 324}
        required: [documentAuthor, documentIdentifier, documentTitle, documentSubjectPatient, documentDate, documentStatus, documentType]
      recordEntryProvenanceData:
        type: BackboneElement
        short: Section 19.2 Record Entry Provenance Data
        index: 325
        elements:
          entrySubjectPatient:
            short: '[PS 19.2.1] Entry subject (Patient) (Mandatory 1..1)'
            elementReference: ['https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/HIQAPatientSummaryLM', elements, github, elements, io/ie-core/fhir/ie/core/StructureDefinition/HIQAPatientSummaryLM#HIQAPatientSummaryLM, elements, patientDetails]
            index: 326
          entryIdentifier: {type: string, short: '[PS 19.2.2] Entry identifier (Optional 0..*)', array: true, index: 327}
          entryAuthor:
            short: '[PS 19.2.3] Entry author (Required 0..*)'
            refers: ['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
            type: Reference
            array: true
            index: 328
          entryDate: {type: dateTime, short: '[PS 19.2.4] Entry date (Required 0..1)', index: 329}
          entrySource: {type: CodeableConcept, short: '[PS 19.2.5] Entry source (Optional 0..1)', index: 330}
          entryLanguage: {type: CodeableConcept, short: '[PS 19.2.6] Entry language (Optional 0..1)', index: 331}
        required: [entrySubjectPatient]
package_version: 0.2.0
class: logical
kind: logical
url: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/HIQAPatientSummaryLM
base: http://hl7.org/fhir/StructureDefinition/Base
version: 0.2.0