FHIR IG Statistics: StructureDefinition/cyehr-sd-person-r4

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "cyehr-sd-person-r4",
  "meta": {
    "versionId": "5",
    "lastUpdated": "2022-07-19T04:40:51.4794457+00:00"
  },
  "url": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4",
  "name": "CYEHRSDPerson",
  "title": "Cyprus EHR Person profile",
  "status": "draft",
  "experimental": true,
  "date": "2022-04-07T11:56:47.6053753+00:00",
  "publisher": "eHealth4U",
  "contact": [
    {
      "name": "eHealth Lab (University of Cyprus)",
      "telecom": [
        {
          "system": "email",
          "value": "ehealthl@ucy.ac.cy",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Person profile for the prototype of the national integrated EHR of Cyprus. The main use-case of this profile is to describe the citizens that live, work or visit Cyprus for a specific period. The profile describes permanent or temporary residents of Cyprus, as well, as tourists.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Person",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Person",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Person",
        "path": "Person",
        "comment": "The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).\r\n\r\nCyprusEHR: The Person profile SHALL be used to describe demographics and administrative information for citizens that participate to the national integrated EHR of Cyprus regardless of their role. When a patient recieves services via the national integrated EHR of Cyprus, the Patient profile SHALL be also used to describe the administrative and demographic data. In the case that a patient uses the national integrated EHR of Cyprus anonymously or with a pseudoname, only the Patient resource SHALL be used (without the use of the Person profile) explicitely stating that the Patient is anonymous or using a pseudoname. In this regard, for the Person profile: the Identifier is mandatory, the name is also mandatory and its use is always official, there SHALL be at least one telecom (either email or phone).",
        "constraint": [
          {
            "key": "cyehr-person-1",
            "severity": "error",
            "human": "All Person instances shall have either a National Identity or a Passport or Alien Registration Card",
            "expression": "identifier.where(system='urn:oid:2.16.840.1.113883.3.9143.2.1.1' or system='urn:oid:2.16.840.1.113883.3.9143.2.1.2' or system='urn:oid:2.16.840.1.113883.3.9143.2.1.3').exists()",
            "source": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4"
          },
          {
            "key": "cyehr-person-2",
            "severity": "error",
            "human": "A citizen must have an identification number registered in Cyprus (nationalIdenitty or Passport with issuing coutnry =Cyprus or ARC) in order to have a national social insurance number",
            "expression": "identifier.where(system='urn:oid:2.16.840.1.113883.3.9143.2.1.4').exists() implies ( identifier.where(system='urn:oid:2.16.840.1.113883.3.9143.2.1.1' or system='urn:oid:2.16.840.1.113883.3.9143.2.1.2').extension('http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-issuingcountry').valueCodeableConcept.coding.where(code = 'CY').exists() or identifier.where(system='urn:oid:2.16.840.1.113883.3.9143.2.1.3').exists() )",
            "source": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4"
          }
        ]
      },
      {
        "id": "Person.meta",
        "path": "Person.meta"
      },
      {
        "id": "Person.meta.profile",
        "path": "Person.meta.profile",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "Person.meta.profile:CyprusEHRProfile",
        "path": "Person.meta.profile",
        "sliceName": "CyprusEHRProfile",
        "min": 1,
        "max": "1",
        "fixedCanonical": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4"
      },
      {
        "id": "Person.identifier",
        "path": "Person.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "$this"
            }
          ],
          "rules": "open"
        },
        "definition": "Identifier for a person within a particular scope.\r\n\r\nCyprusEHR: Identifiers should be provided for every person registered in national integrated EHR system of Cyprus. There are four possible identifiers that can be used: (1) the national identity and the issuing country (2) the passport and the issuing country  (3) the Alien Resident Card (in Cyprus) and (4) the Social Insurance Services. A Person SHALL have at least one of the first three identifiers.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Person.identifier.system",
        "path": "Person.identifier.system",
        "min": 1
      },
      {
        "id": "Person.identifier.value",
        "path": "Person.identifier.value",
        "min": 1
      },
      {
        "id": "Person.identifier:nationalIdentity",
        "path": "Person.identifier",
        "sliceName": "nationalIdentity",
        "short": "National Identification Number from any country.",
        "definition": "Identifier for a person within a particular scope.\r\n\r\nCyprusEHR: Represents the national identity as published by a specific country. Therefore, the value of the nationalIdentity is the combination of a country code (see issuingCountry: http://hl7.org/fhir/ValueSet/iso3166-1-2) + the special character \"/\" + the national identity number (e.g. CY/1234567, GR/X-982120). The nationalIdentity can be used to record the national identity number of a person from any country included in the value set defined by the ISO 3166-1.",
        "comment": "CyprusEHR: For national identity card of Cyprus: http://moi.gov.cy/moi/CRMD/crmd.nsf/All/6263F7FAF548FDF0C2257D2C0030B3D7?OpenDocument\r\n\r\nCyprusEHR: The nationalIdentity.system is the number taken from the NeHA OID tree representing the national identification number as an indentification mechanism for humans.",
        "max": "1",
        "patternIdentifier": {
          "use": "official",
          "system": "urn:oid:2.16.840.1.113883.3.9143.2.1.1"
        },
        "constraint": [
          {
            "key": "cyehr-person-3",
            "severity": "error",
            "human": "If the identification is nationalIdentity or passport then the first 2 digits of the identification.value must be the same with the issuingCountry and the third digit must be the slash character",
            "expression": "value.substring(0,3) = extension('http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-issuingcountry').valueCodeableConcept.coding.code + '/'",
            "source": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4"
          }
        ]
      },
      {
        "id": "Person.identifier:nationalIdentity.extension",
        "path": "Person.identifier.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "Person.identifier:nationalIdentity.extension:issuingCountry",
        "path": "Person.identifier.extension",
        "sliceName": "issuingCountry",
        "short": "Issuing country of the person's national identity.",
        "definition": "Issuing country of the person's national identity using a 2-code of ISO 3166-1 countries.",
        "min": 1,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-issuingcountry"
            ]
          }
        ]
      },
      {
        "id": "Person.identifier:nationalIdentity.extension:issuingCountry.value[x]",
        "path": "Person.identifier.extension.value[x]",
        "binding": {
          "strength": "extensible",
          "description": "Iso 3166 Part 1: 2 Letter Codes",
          "valueSet": "http://hl7.org/fhir/ValueSet/iso3166-1-2"
        }
      },
      {
        "id": "Person.identifier:nationalIdentity.extension:issuingCountry.value[x].coding.system",
        "path": "Person.identifier.extension.value[x].coding.system",
        "min": 1,
        "fixedUri": "urn:iso:std:iso:3166"
      },
      {
        "id": "Person.identifier:nationalIdentity.extension:issuingCountry.value[x].coding.code",
        "path": "Person.identifier.extension.value[x].coding.code",
        "min": 1
      },
      {
        "id": "Person.identifier:nationalIdentity.extension:issuingCountry.value[x].coding.display",
        "path": "Person.identifier.extension.value[x].coding.display",
        "min": 1
      },
      {
        "id": "Person.identifier:nationalIdentity.system",
        "path": "Person.identifier.system",
        "min": 1
      },
      {
        "id": "Person.identifier:nationalIdentity.value",
        "path": "Person.identifier.value",
        "min": 1
      },
      {
        "id": "Person.identifier:passport",
        "path": "Person.identifier",
        "sliceName": "passport",
        "short": "The passport as identification of a human.",
        "definition": "Identifier for a person within a particular scope.\r\n\r\nCyprusEHR: Represents the passport as published by a specific country. Therefore, the value of the passport is the combination of a country code (see issuingCountry: http://hl7.org/fhir/ValueSet/iso3166-1-2) + the special character \"/\" + the passport number (e.g. CY/K675677768E, CN/E65050920). The passport can be used to record the passport number of a person from any country included in the value set defined by the ISO 3166-1.",
        "comment": "CyprusEHR: The passport.system is the number taken from the NeHA OID tree representing the passport number as an indentification mechanism for humans.",
        "max": "1",
        "patternIdentifier": {
          "use": "official",
          "system": "urn:oid:2.16.840.1.113883.3.9143.2.1.2"
        },
        "constraint": [
          {
            "key": "cyehr-person-4",
            "severity": "error",
            "human": "If the identification is nationalIdentity or passport then the first 2 digits of the identification.value must be the same with the issuingCountry and the third digit must be the slash character",
            "expression": "value.substring(0,3) = extension('http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-issuingcountry').valueCodeableConcept.coding.code + '/'",
            "source": "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4"
          }
        ]
      },
      {
        "id": "Person.identifier:passport.extension",
        "path": "Person.identifier.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 1
      },
      {
        "id": "Person.identifier:passport.extension:issuingCountry",
        "path": "Person.identifier.extension",
        "sliceName": "issuingCountry",
        "short": "Issuing country of the person's passport.",
        "definition": "CyprusEHR: Issuing country of the person's passport using a 2-code of ISO 3166-1 countries.",
        "min": 1,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-ext-issuingcountry"
            ]
          }
        ]
      },
      {
        "id": "Person.identifier:passport.extension:issuingCountry.value[x]",
        "path": "Person.identifier.extension.value[x]",
        "binding": {
          "strength": "extensible",
          "description": "Iso 3166 Part 1: 2 Letter Codes",
          "valueSet": "http://hl7.org/fhir/ValueSet/iso3166-1-2"
        }
      },
      {
        "id": "Person.identifier:passport.extension:issuingCountry.value[x].coding.system",
        "path": "Person.identifier.extension.value[x].coding.system",
        "min": 1,
        "fixedUri": "urn:iso:std:iso:3166"
      },
      {
        "id": "Person.identifier:passport.extension:issuingCountry.value[x].coding.code",
        "path": "Person.identifier.extension.value[x].coding.code",
        "min": 1
      },
      {
        "id": "Person.identifier:passport.extension:issuingCountry.value[x].coding.display",
        "path": "Person.identifier.extension.value[x].coding.display",
        "min": 1
      },
      {
        "id": "Person.identifier:passport.system",
        "path": "Person.identifier.system",
        "min": 1
      },
      {
        "id": "Person.identifier:passport.value",
        "path": "Person.identifier.value",
        "min": 1
      },
      {
        "id": "Person.identifier:alienResidentCard",
        "path": "Person.identifier",
        "sliceName": "alienResidentCard",
        "short": "Alien Resident Card Number as registered in Cyprus.",
        "definition": "Identifier for a person within a particular scope.\r\n\r\nCyprusEHR: Represents the Alien Resident Card Number as registered in Cyprus.",
        "comment": "CyprusEHR: The registration certificate, or administratively called MEU-1 or MEU-2, identified as the Yellow slip (simply because it's printed on Yellow sheets) is available to everyone wishing to live, work or simply visitors desiring to have a long term residence in Cyprus.\r\n\r\n-The MEU-1 is only available for EEA Citizens and citizens of the Swiss Confederation . European Economic Area, abbreviate as EEA, consisted of 27 members states of Europeans Union + 3 countries of the European Free Trade Associations ( Island, Liechtenstein and Norway). -The MEU-2 is done for family-members of Europeans members citizens that are nor-europeans citizens. -The MEU-3 is the available after 5 years residency in Cyprus. You will obtain a permanent resident id-card. It is available for europeans citizens.\r\n\r\nPink Slip is for the non-europeans who are settled in Cyprus, called Cyprus temporary residence permit. It also enables tourists and visitors to extend their stay no matter what was the duration of their initial visa.\r\n\r\nhttp://moi.gov.cy/moi/CRMD/crmd.nsf/page07_en/page07_en?OpenDocument\r\n\r\nCyprusEHR: The alienResidentCard.system is the number taken from the NeHA OID tree representing the alien resident card number of Cyprus as an indentification mechanism for humans.",
        "alias": [
          "Yellow Slip",
          "MEU-1",
          "MEU-2",
          "MEU-3",
          "Registration certificate",
          "Pink Slip"
        ],
        "max": "1",
        "patternIdentifier": {
          "use": "official",
          "system": "urn:oid:2.16.840.1.113883.3.9143.2.1.3"
        }
      },
      {
        "id": "Person.identifier:alienResidentCard.system",
        "path": "Person.identifier.system",
        "min": 1
      },
      {
        "id": "Person.identifier:alienResidentCard.value",
        "path": "Person.identifier.value",
        "min": 1
      },
      {
        "id": "Person.identifier:socialInsuranceServices",
        "path": "Person.identifier",
        "sliceName": "socialInsuranceServices",
        "short": "Social Insurance Services",
        "definition": "Identifier for a person within a particular scope.\r\n\r\nCyprusEHR: Represents the Social Insurance Services number as registered in Cyprus.",
        "comment": "CyprusEHR: A number Social Insurance Services Number is provided by the Ministry of Labour, Welfare and Social Insurance of Cyprus to all Cypriot and EU citizens for their contribution to the Social Insurance Scheme. http://www.mlsi.gov.cy/mlsi/sid/sidv2.nsf/index_en/index_en\r\n\r\nCyprusEHR: The socialInsuranceServices.system is the number taken from the NeHA OID tree representing the social insurance services number of Cyprus as an indentification mechanism for humans.",
        "max": "1",
        "patternIdentifier": {
          "use": "official",
          "system": "urn:oid:2.16.840.1.113883.3.9143.2.1.4"
        }
      },
      {
        "id": "Person.identifier:socialInsuranceServices.system",
        "path": "Person.identifier.system",
        "min": 1
      },
      {
        "id": "Person.identifier:socialInsuranceServices.value",
        "path": "Person.identifier.value",
        "min": 1
      },
      {
        "id": "Person.name",
        "path": "Person.name",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "HumanName",
            "profile": [
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-humanname"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Person.name.use",
        "path": "Person.name.use",
        "definition": "Identifies the purpose for this name.\r\n\r\nCyprusEHR: As recorded on their identifiers.",
        "min": 1,
        "fixedCode": "official"
      },
      {
        "id": "Person.telecom",
        "path": "Person.telecom",
        "mustSupport": true
      },
      {
        "id": "Person.gender",
        "path": "Person.gender",
        "mustSupport": true
      },
      {
        "id": "Person.birthDate",
        "path": "Person.birthDate",
        "mustSupport": true
      },
      {
        "id": "Person.address",
        "path": "Person.address",
        "short": "One or more addresses for the person.",
        "definition": "One or more addresses for the person.\r\n\r\nCyprusEHR: It SHOULD be used for home addresses (address.use = home).",
        "type": [
          {
            "code": "Address",
            "profile": [
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-address",
              "http://hl7.org/fhir/StructureDefinition/Address"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Person.managingOrganization",
        "path": "Person.managingOrganization",
        "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.\r\n\r\nCyprusEHR: managingOrganization for the national Integrated EHR of Cyprus SHALL be the National eHealth Authority of Cyprus (NeHA).",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Organization",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-organization-r4"
            ],
            "aggregation": [
              "referenced"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Person.active",
        "path": "Person.active",
        "label": "Active Record",
        "comment": "CyprusEHR: A Person SHALL be inactivated if citizen is dead or if the Person record was created in error.",
        "min": 1
      },
      {
        "id": "Person.link",
        "path": "Person.link",
        "mustSupport": true
      },
      {
        "id": "Person.link.target",
        "path": "Person.link.target",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "http://hl7.org/fhir/StructureDefinition/Person",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-patient",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-practitioner-r4",
              "http://ig.ehealth4u.eu/fhir/StructureDefinition/cyehr-sd-person-r4"
            ],
            "aggregation": [
              "referenced"
            ]
          }
        ]
      }
    ]
  }
}