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

FHIR IG analytics

Packagenostalgic-ie.fhir.core
Resource TypeStructureDefinition
IdStructureDefinition-ie-core-patient.json
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=nostalgic-ie.fhir.core@0.2.0&canonical=https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient
URLhttps://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient
Version0.2.0
Statusdraft
NameIECorePatient
TitleIE Core Patient
DescriptionBase Patient profile for the Irish health system, derived from the HL7 Europe Base Patient. It is deliberately permissive: special-category and identity-disambiguation data (for example ethnicity or mother's maiden name) are allowed but NOT MustSupport. Use-case profiles decide what must be sent and what must not be sent: IECorePatientEPrescription for ePrescription and eDispensation, and IECorePatientSummaryPatient for the Patient Summary (ADR-002, GDPR Art. 5(1)(c) data minimisation).
TypePatient
Kindresource

Resources that use this resource

CapabilityStatement
nostalgic-ie.fhir.core#0.2.0ie-core-clientIE Core Client CapabilityStatement
nostalgic-ie.fhir.core#0.2.0ie-core-serverIE Core Server CapabilityStatement
StructureDefinition
nostalgic-ie.fhir.core#0.2.0ie-core-allergyintoleranceIE Core AllergyIntolerance
nostalgic-ie.fhir.core#0.2.0ie-core-careplanIE Core CarePlan
nostalgic-ie.fhir.core#0.2.0ie-core-careteamIE Core CareTeam
nostalgic-ie.fhir.core#0.2.0ie-core-composition-discharge-reportIE Core Composition (Hospital Discharge Report)
nostalgic-ie.fhir.core#0.2.0ie-core-condition-encounter-diagnosisIE Core Condition Encounter Diagnosis
nostalgic-ie.fhir.core#0.2.0ie-core-condition-problems-health-concernsIE Core Condition Problems and Health Concerns
nostalgic-ie.fhir.core#0.2.0ie-core-coverageIE Core Coverage
nostalgic-ie.fhir.core#0.2.0ie-core-diagnosticreport-labIE Core DiagnosticReport for Laboratory Results
nostalgic-ie.fhir.core#0.2.0ie-core-diagnosticreport-noteIE Core DiagnosticReport for Report and Note Exchange
nostalgic-ie.fhir.core#0.2.0ie-core-documentreferenceIE Core DocumentReference
nostalgic-ie.fhir.core#0.2.0ie-core-encounterIE Core Encounter
nostalgic-ie.fhir.core#0.2.0ie-core-flagIE Core Flag (Alert)
nostalgic-ie.fhir.core#0.2.0ie-core-goalIE Core Goal
nostalgic-ie.fhir.core#0.2.0ie-core-immunizationIE Core Immunization
nostalgic-ie.fhir.core#0.2.0ie-core-implantable-deviceIE Core Implantable Device
nostalgic-ie.fhir.core#0.2.0ie-core-laboratory-reportIE Core Laboratory Report
nostalgic-ie.fhir.core#0.2.0ie-core-medicationdispenseIE Core MedicationDispense
nostalgic-ie.fhir.core#0.2.0ie-core-medicationrequestIE Core MedicationRequest
nostalgic-ie.fhir.core#0.2.0ie-core-medicationstatementIE Core MedicationStatement
nostalgic-ie.fhir.core#0.2.0ie-core-patient-eprescriptionIE Core Patient (ePrescription/eDispensation)
nostalgic-ie.fhir.core#0.2.0ie-core-procedureIE Core Procedure
nostalgic-ie.fhir.core#0.2.0ie-core-provenanceIE Core Provenance
nostalgic-ie.fhir.core#0.2.0ie-core-questionnaireresponseIE Core QuestionnaireResponse
nostalgic-ie.fhir.core#0.2.0ie-core-relatedpersonIE Core RelatedPerson
nostalgic-ie.fhir.core#0.2.0ie-core-servicerequestIE Core ServiceRequest
nostalgic-ie.fhir.core#0.2.0ie-core-specimenIE Core Specimen

Resources that this resource uses

StructureDefinition
hl7.fhir.eu.base#currentpatient-eu-corePatient (EU core)
nostalgic-ie.fhir.core#0.2.0ie-core-ethnicityIE Core Ethnicity
nostalgic-ie.fhir.core#0.2.0ie-core-organizationIE Core Organization
nostalgic-ie.fhir.core#0.2.0ie-core-practitionerIE Core Practitioner
nostalgic-ie.fhir.core#0.2.0ie-core-practitionerroleIE Core PractitionerRole
ValueSet
nostalgic-ie.fhir.core#0.2.0ie-core-countyIreland Counties

Narrative

No narrative content found in resource


Source1

{
  "resourceType": "StructureDefinition",
  "id": "ie-core-patient",
  "url": "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient",
  "version": "0.2.0",
  "name": "IECorePatient",
  "title": "IE Core Patient",
  "status": "draft",
  "description": "Base Patient profile for the Irish health system, derived from the HL7 Europe Base Patient. It is deliberately permissive: special-category and identity-disambiguation data (for example ethnicity or mother's maiden name) are allowed but NOT MustSupport. Use-case profiles decide what must be sent and what must not be sent: IECorePatientEPrescription for ePrescription and eDispensation, and IECorePatientSummaryPatient for the Patient Summary (ADR-002, GDPR Art. 5(1)(c) data minimisation).",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Patient",
  "baseDefinition": "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Patient.extension:gender-identity",
        "path": "Patient.extension",
        "sliceName": "gender-identity",
        "short": "Gender identity (HIQA gender cluster)",
        "comment": "HIQA EP 1.4.4 / PS 1.4.5 Gender cluster (Required 0..1). 'Other gender identity' free text (EP 1.4.4.2 / PS 1.4.5.2) goes in valueCodeableConcept.text.",
        "mustSupport": true
      },
      {
        "id": "Patient.extension:pronouns",
        "path": "Patient.extension",
        "sliceName": "pronouns",
        "short": "Personal pronouns (not in either HIQA dataset)"
      },
      {
        "id": "Patient.extension:sexAssignedAtBirth",
        "path": "Patient.extension",
        "sliceName": "sexAssignedAtBirth",
        "short": "Sex assigned at birth (recorded sex, type LOINC 76689-9)",
        "definition": "The patient's sex assigned at birth, recorded with individual-recordedSexOrGender and typed with LOINC 76689-9 'Sex assigned at birth'. This is distinct from Patient.gender (administrative gender) and from gender identity.",
        "comment": "HIQA EP 1.4.3 / PS 1.4.4 Sex (Mandatory 1..1). Mandatory in the use-case profiles (ADR-002). Displaying sex at birth alongside gender identity can disclose a gender reassignment; see the security guidance.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Patient.extension:sexAssignedAtBirth.extension",
        "path": "Patient.extension.extension",
        "min": 2
      },
      {
        "id": "Patient.extension:sexAssignedAtBirth.extension:type",
        "path": "Patient.extension.extension",
        "sliceName": "type",
        "min": 1
      },
      {
        "id": "Patient.extension:sexAssignedAtBirth.extension:type.value[x]",
        "path": "Patient.extension.extension.value[x]",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "76689-9",
              "display": "Sex assigned at birth"
            }
          ]
        }
      },
      {
        "id": "Patient.extension:ethnicity",
        "path": "Patient.extension",
        "sliceName": "ethnicity",
        "short": "Ethnicity (special-category data; Patient Summary only)",
        "comment": "GDPR Art. 9 special-category data. HIQA PS 1.4.10 (Required 0..*). Not part of the HIQA ePrescription dataset, and prohibited in IECorePatientEPrescription (ADR-002).",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ethnicity"
            ]
          }
        ]
      },
      {
        "id": "Patient.extension:mothersMaidenName",
        "path": "Patient.extension",
        "sliceName": "mothersMaidenName",
        "short": "Mother's maiden name (not MustSupport)",
        "comment": "Not part of the HIQA ePrescription dataset. The Patient Summary uses IECoreMothersFormerSurname (HIQA PS 1.4.6, 0..*).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"
            ]
          }
        ]
      },
      {
        "id": "Patient.extension:interpreterRequired",
        "path": "Patient.extension",
        "sliceName": "interpreterRequired",
        "short": "Whether the patient requires an interpreter",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
            ]
          }
        ]
      },
      {
        "id": "Patient.identifier",
        "path": "Patient.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "short": "Identifiers for this patient",
        "comment": "HIQA EP/PS 1.3. Identifiers other than the IHI (and the PPSN in the use-case profiles) are carried as 'other identifiers used in health and social care' (HIQA 1.3.3): type, value, validity period and issuing organisation. Examples from HIQA include PCRS scheme numbers (medical card, GP visit card, DPS, LTI, HAA), GP record number, MRN, NHS number and EHIC.",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.type",
        "path": "Patient.identifier.type",
        "comment": "HIQA EP/PS 1.3.3.1 (Required).",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.value",
        "path": "Patient.identifier.value",
        "comment": "HIQA EP/PS 1.3.3.2 (Required).",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.period",
        "path": "Patient.identifier.period",
        "comment": "HIQA EP/PS 1.3.3.3 (Required).",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.assigner",
        "path": "Patient.identifier.assigner",
        "comment": "HIQA EP/PS 1.3.3.4 (Required): name of the issuing organisation (assigner.display), for example 'HSE'.",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier:IHI",
        "path": "Patient.identifier",
        "sliceName": "IHI",
        "short": "Individual Health Identifier (IHI)",
        "definition": "The Individual Health Identifier assigned by the HSE. HIQA describes it as a unique 18 or 10-digit number.",
        "comment": "HIQA EP/PS 1.3.1 (Required 0..1). The system URI is a placeholder pending an HSE-published URI (OI-003). The relationship between the 18- and 10-digit forms is Requires Clarification (OI-002).",
        "min": 0,
        "max": "1",
        "constraint": [
          {
            "key": "ie-pat-1",
            "severity": "error",
            "human": "IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number')",
            "expression": "value.matches('^([0-9]{18}|[0-9]{10})[%content%]#39;)",
            "source": "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Patient.identifier:IHI.type",
        "path": "Patient.identifier.type",
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
              "code": "NI",
              "display": "National unique individual identifier"
            }
          ]
        }
      },
      {
        "id": "Patient.identifier:IHI.system",
        "path": "Patient.identifier.system",
        "min": 1,
        "patternUri": "https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier:IHI.value",
        "path": "Patient.identifier.value",
        "short": "IHI number (18 or 10 digits)",
        "min": 1
      },
      {
        "id": "Patient.name",
        "path": "Patient.name",
        "mustSupport": true
      },
      {
        "id": "Patient.name.use",
        "path": "Patient.name.use",
        "mustSupport": true
      },
      {
        "id": "Patient.name.family",
        "path": "Patient.name.family",
        "short": "Family name (surname)",
        "mustSupport": true
      },
      {
        "id": "Patient.name.given",
        "path": "Patient.name.given",
        "short": "Given names (first and middle names)",
        "mustSupport": true
      },
      {
        "id": "Patient.name.prefix",
        "path": "Patient.name.prefix",
        "mustSupport": true
      },
      {
        "id": "Patient.name.suffix",
        "path": "Patient.name.suffix",
        "mustSupport": true
      },
      {
        "id": "Patient.telecom",
        "path": "Patient.telecom",
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.system",
        "path": "Patient.telecom.system",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.value",
        "path": "Patient.telecom.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.use",
        "path": "Patient.telecom.use",
        "mustSupport": true
      },
      {
        "id": "Patient.gender",
        "path": "Patient.gender",
        "short": "Administrative gender (not sex assigned at birth)",
        "comment": "Administrative gender for record-keeping. Sex assigned at birth (HIQA EP 1.4.3 / PS 1.4.4) is carried in extension[sexAssignedAtBirth], and gender identity in extension[gender-identity].",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.birthDate",
        "path": "Patient.birthDate",
        "short": "The date of birth for the patient",
        "comment": "HIQA EP/PS 1.4.1 Date of birth (Mandatory 1..1). 1..1 is inherited from HL7 Europe Base patient-eu-core.",
        "mustSupport": true
      },
      {
        "id": "Patient.deceased[x]",
        "path": "Patient.deceased[x]",
        "mustSupport": true
      },
      {
        "id": "Patient.address",
        "path": "Patient.address",
        "short": "An address for the patient (Irish address)",
        "mustSupport": true
      },
      {
        "id": "Patient.address.use",
        "path": "Patient.address.use",
        "mustSupport": true
      },
      {
        "id": "Patient.address.line",
        "path": "Patient.address.line",
        "mustSupport": true
      },
      {
        "id": "Patient.address.city",
        "path": "Patient.address.city",
        "short": "Suburb, town, townland or locality (Dublin postal district, e.g. 'Dublin 2', goes here)",
        "mustSupport": true
      },
      {
        "id": "Patient.address.state",
        "path": "Patient.address.state",
        "short": "County",
        "definition": "The Irish county. Bound to the IE Core County ValueSet.",
        "mustSupport": true,
        "binding": {
          "strength": "extensible",
          "valueSet": "https://hl7-ie.github.io/ie-core/fhir/ie/core/ValueSet/ie-core-county"
        }
      },
      {
        "id": "Patient.address.postalCode",
        "path": "Patient.address.postalCode",
        "short": "Eircode or postal code (Eircode format XXX XXXX)",
        "mustSupport": true
      },
      {
        "id": "Patient.address.country",
        "path": "Patient.address.country",
        "short": "Country (ISO 3166-1 alpha-2)",
        "mustSupport": true
      },
      {
        "id": "Patient.communication",
        "path": "Patient.communication",
        "mustSupport": true
      },
      {
        "id": "Patient.communication.language",
        "path": "Patient.communication.language",
        "mustSupport": true
      },
      {
        "id": "Patient.generalPractitioner",
        "path": "Patient.generalPractitioner",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-organization",
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-practitioner",
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-practitionerrole"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Patient.managingOrganization",
        "path": "Patient.managingOrganization",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-organization"
            ]
          }
        ],
        "mustSupport": true
      }
    ]
  }
}