FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ie-core-patient-summary-patient",
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-imposeProfile",
      "valueCanonical": "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient"
    }
  ],
  "url": "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient-summary-patient",
  "version": "0.2.0",
  "name": "IECorePatientSummaryPatient",
  "title": "IE Core Patient (Patient Summary)",
  "status": "draft",
  "description": "The patient as the subject of an Irish Patient Summary. It carries the HIQA Patient Summary demographic dataset (Section 1), including the Required demographics that are NOT part of the ePrescription dataset (ethnicity, nationality, mother's former surnames, place of birth, country of affiliation), and the nominated contact person (Section 3). Marital status, religion and pronouns are in neither HIQA dataset and are prohibited. Derived from the HL7 Europe Patient Summary patient (which imposes the IPS patient) and imposes IECorePatient.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Patient",
  "baseDefinition": "http://hl7.eu/fhir/eps/StructureDefinition/patient-eu-eps",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Patient.extension",
        "path": "Patient.extension",
        "min": 1
      },
      {
        "id": "Patient.extension:birthPlace",
        "path": "Patient.extension",
        "sliceName": "birthPlace",
        "comment": "HIQA PS 1.4.3 Place of birth (Required 0..1): the county (in Ireland) or city (elsewhere) of birth, carried in valueAddress.state or valueAddress.city.",
        "mustSupport": true
      },
      {
        "id": "Patient.extension:gender-identity",
        "path": "Patient.extension",
        "sliceName": "gender-identity",
        "comment": "HIQA PS 1.4.5 Gender cluster (Required 0..1): 1.4.5.1 Gender (coded) and 1.4.5.2 Other gender identity (valueCodeableConcept.text).",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Patient.extension:pronouns",
        "path": "Patient.extension",
        "sliceName": "pronouns",
        "comment": "Prohibited: not in the HIQA PS dataset.",
        "max": "0"
      },
      {
        "id": "Patient.extension:patient-nationality",
        "path": "Patient.extension",
        "sliceName": "patient-nationality",
        "comment": "HIQA PS 1.4.7 Nationality (Required 0..*, coded): country of legal citizenship.",
        "mustSupport": true
      },
      {
        "id": "Patient.extension:sexAssignedAtBirth",
        "path": "Patient.extension",
        "sliceName": "sexAssignedAtBirth",
        "comment": "HIQA PS 1.4.4 Sex (Mandatory 1..1): sex assigned at birth, e.g. male or female.",
        "min": 1,
        "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",
        "comment": "HIQA PS 1.4.10 Ethnicity (Required 0..*, coded). GDPR Art. 9 special-category data: send only when recorded with appropriate safeguards and consent. HIQA says it is not used for patient identification.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ethnicity"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Patient.extension:mothersFormerSurname",
        "path": "Patient.extension",
        "sliceName": "mothersFormerSurname",
        "comment": "HIQA PS 1.4.6 Mother's former surnames (Required 0..*). OI-011.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-mothers-former-surname"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Patient.extension:countryOfAffiliation",
        "path": "Patient.extension",
        "sliceName": "countryOfAffiliation",
        "comment": "HIQA PS 1.4.8 Country of affiliation (Required 0..1).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-country-of-affiliation"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Patient.extension:religion",
        "path": "Patient.extension",
        "sliceName": "religion",
        "comment": "Prohibited: not in the HIQA PS dataset; GDPR Art. 9 special-category data.",
        "min": 0,
        "max": "0",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/patient-religion"
            ]
          }
        ]
      },
      {
        "id": "Patient.identifier",
        "path": "Patient.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "comment": "HIQA PS 1.3.1 IHI (slice imposed by IECorePatient), 1.3.2 PPSN, 1.3.3 other identifiers (type, value, period, issuing organisation; all Required).",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.type",
        "path": "Patient.identifier.type",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.value",
        "path": "Patient.identifier.value",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.period",
        "path": "Patient.identifier.period",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier.assigner",
        "path": "Patient.identifier.assigner",
        "mustSupport": true
      },
      {
        "id": "Patient.identifier:PPSN",
        "path": "Patient.identifier",
        "sliceName": "PPSN",
        "short": "Personal Public Service Number (PPSN): Requires Clarification",
        "comment": "HIQA PS 1.3.2 (Required 0..1). Deliberately NOT MustSupport: the legal basis for using the PPSN as a health identifier is Requires Clarification (OI-008). The IHI (PS 1.3.1) slice is imposed by IECorePatient.",
        "min": 0,
        "max": "1",
        "constraint": [
          {
            "key": "ie-pat-ppsn-1",
            "severity": "warning",
            "human": "PPSN format: seven numbers followed by one or two letters (HIQA EP/PS 1.3.2)",
            "expression": "value.matches('^[0-9]{7}[A-Za-z]{1,2}[%content%]#39;)",
            "source": "https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-patient-summary-patient"
          }
        ]
      },
      {
        "id": "Patient.identifier:PPSN.system",
        "path": "Patient.identifier.system",
        "min": 1,
        "patternUri": "https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/pps"
      },
      {
        "id": "Patient.identifier:PPSN.value",
        "path": "Patient.identifier.value",
        "min": 1
      },
      {
        "id": "Patient.name",
        "path": "Patient.name",
        "mustSupport": true
      },
      {
        "id": "Patient.name.use",
        "path": "Patient.name.use",
        "comment": "HIQA PS 1.1.6 Former names (Required 0..*) use 'old'; 1.1.7 Preferred name (Required 0..1) uses 'usual'.",
        "mustSupport": true
      },
      {
        "id": "Patient.name.family",
        "path": "Patient.name.family",
        "comment": "HIQA PS 1.1.4 Surname (Mandatory 1..1).",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.name.given",
        "path": "Patient.name.given",
        "comment": "HIQA PS 1.1.2 Forename (Mandatory 1..1); PS 1.1.3 Middle name(s) (Required 0..1) as further given names.",
        "min": 1,
        "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",
        "comment": "HIQA PS 1.5.1 Mobile phone, 1.5.2 Email (Required); 1.5.3 Other communication details (Optional); 1.5.4 Preferred communication method (Required), expressed by rank = 1.",
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.system",
        "path": "Patient.telecom.system",
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.value",
        "path": "Patient.telecom.value",
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.use",
        "path": "Patient.telecom.use",
        "mustSupport": true
      },
      {
        "id": "Patient.telecom.rank",
        "path": "Patient.telecom.rank",
        "mustSupport": true
      },
      {
        "id": "Patient.gender",
        "path": "Patient.gender",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.birthDate",
        "path": "Patient.birthDate",
        "comment": "HIQA PS 1.4.1 Date of birth (Mandatory 1..1). HIQA: if unknown, record 1900-01-01 (estimated age, PS 1.4.2, is Optional and not modelled).",
        "mustSupport": true
      },
      {
        "id": "Patient.deceased[x]",
        "path": "Patient.deceased[x]",
        "comment": "HIQA PS 1.4.11 Date of death (Required 0..1) as deceasedDateTime. PS 1.4.12 Cause of death (Required) has no Patient element: Requires Clarification.",
        "mustSupport": true
      },
      {
        "id": "Patient.address",
        "path": "Patient.address",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.address.use",
        "path": "Patient.address.use",
        "comment": "HIQA PS 1.2.6 Address type (Mandatory 1..1).",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.address.line",
        "path": "Patient.address.line",
        "comment": "HIQA PS 1.2.2 Address line(s) (Mandatory 1..1).",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.address.city",
        "path": "Patient.address.city",
        "mustSupport": true
      },
      {
        "id": "Patient.address.state",
        "path": "Patient.address.state",
        "comment": "HIQA PS 1.2.4 District/County (Mandatory 1..1).",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Patient.address.postalCode",
        "path": "Patient.address.postalCode",
        "mustSupport": true
      },
      {
        "id": "Patient.address.country",
        "path": "Patient.address.country",
        "mustSupport": true
      },
      {
        "id": "Patient.maritalStatus",
        "path": "Patient.maritalStatus",
        "comment": "Prohibited: not in the HIQA PS dataset.",
        "max": "0"
      },
      {
        "id": "Patient.contact",
        "path": "Patient.contact",
        "short": "Nominated contact person (HIQA PS Section 3)",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.relationship",
        "path": "Patient.contact.relationship",
        "comment": "HIQA PS 3.3 Role (Required 0..*) and 3.4 Relationship (Required 0..1).",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.name",
        "path": "Patient.contact.name",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.name.family",
        "path": "Patient.contact.name.family",
        "comment": "HIQA PS 3.2 Surname of nominated contact person (Required 0..1).",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.name.given",
        "path": "Patient.contact.name.given",
        "comment": "HIQA PS 3.1 Forename of nominated contact person (Required 0..1).",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.telecom",
        "path": "Patient.contact.telecom",
        "comment": "HIQA PS 3.5 Communication details (Required): 3.5.1 mobile, 3.5.2 landline, 3.5.3 email.",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.telecom.rank",
        "path": "Patient.contact.telecom.rank",
        "comment": "HIQA PS 3.7 Preferred communication type for the nominated contact person (Required): rank = 1.",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.address",
        "path": "Patient.contact.address",
        "comment": "HIQA PS 3.6 Address of nominated contact person (Optional 0..1)."
      },
      {
        "id": "Patient.contact.address.line",
        "path": "Patient.contact.address.line",
        "comment": "HIQA PS 3.6.2 Address line(s): Mandatory when the contact address is given.",
        "min": 1
      },
      {
        "id": "Patient.contact.address.city",
        "path": "Patient.contact.address.city",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.address.state",
        "path": "Patient.contact.address.state",
        "comment": "HIQA PS 3.6.4 District/County/City: Mandatory when the contact address is given.",
        "min": 1
      },
      {
        "id": "Patient.contact.address.postalCode",
        "path": "Patient.contact.address.postalCode",
        "mustSupport": true
      },
      {
        "id": "Patient.contact.address.country",
        "path": "Patient.contact.address.country",
        "mustSupport": true
      },
      {
        "id": "Patient.communication",
        "path": "Patient.communication",
        "comment": "HIQA PS 1.4.9 Preferred language (Optional 0..*), including sign language.",
        "mustSupport": true
      },
      {
        "id": "Patient.communication.language",
        "path": "Patient.communication.language",
        "mustSupport": true
      },
      {
        "id": "Patient.generalPractitioner",
        "path": "Patient.generalPractitioner",
        "comment": "HIQA PS Section 2: General Practitioner details must be captured in all cases.",
        "mustSupport": true
      }
    ]
  }
}