| Package | smart.who.int.immunizations |
| Resource Type | StructureDefinition |
| Id | IMMZC4 |
| FHIR Version | R4 |
| Source | http://smart.who.int/immunizations/https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/StructureDefinition-IMMZC4.html |
| URL | http://smart.who.int/immunizations/StructureDefinition/IMMZC4 |
| Version | 0.2.0 |
| Status | active |
| Date | 2024-12-18 |
| Name | IMMZ_C4_Create_client_record |
| Title | IMMZ.C4.Create client record |
| Authority | who |
| Description | Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details. |
| Type | http://smart.who.int/immunizations/StructureDefinition/IMMZC4 |
| Kind | logical |
No resources found
| ValueSet | |
| IMMZ.C.DE5 | IMMZ.C.DE5 ValueSet for Sex |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition IMMZC4
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  IMMZC4 | 0..* | Base | IMMZ.C4.Create client record | |
  uniqueIdentifier | 1..1 | string | Unique identifier | |
| name | C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName | C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName | C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| sex | 1..1 | code | Sex Binding: IMMZ.C.DE5 ValueSet for Sex (required) | |
| dateOfBirth | 1..1 | string | Date of birth | |
| age | C | 0..1 | string | Age Constraints: IMMZ-C-age-1 |
 caregiversMultiple | 0..* | BackboneElement | Caregivers (multiple) | |
 caregiversFullName | C | 0..1 | string | Caregiver's full name Constraints: IMMZ-C-name-1 |
| caregiversFirstName | C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
 caregiversFamilyName | C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber | 1..1 | string | Contact phone number | |
| address | 1..1 | string | Address | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "IMMZC4",
"meta": {
"profile": [
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition",
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition"
]
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability",
"valueCode": "shareable"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm",
"valueCoding": {
"system": "http://hl7.org/fhir/version-algorithm",
"code": "semver"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/artifact-version-policy-codes",
"code": "metadata"
}
]
}
}
],
"url": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4",
"version": "0.2.0",
"name": "IMMZ_C4_Create_client_record",
"title": "IMMZ.C4.Create client record",
"status": "active",
"experimental": false,
"date": "2024-12-18",
"publisher": "WHO",
"contact": [
{
"name": "WHO",
"telecom": [
{
"system": "url",
"value": "http://who.int"
}
]
}
],
"description": "Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"uri": "http://smart.who.int/immunizations/StructureDefinition/IMMZPatient",
"name": "Mapping from the IMMZ.C4 to the IMMZPatient profile"
},
{
"identity": "IMMZC4.to.RelatedPerson",
"uri": "http://smart.who.int/immunizations/StructureDefinition/IMMZCaregiver",
"name": "Mapping from the IMMZ.C4 to the IMMZCaregiver (RelatedPerson) profile"
}
],
"kind": "logical",
"abstract": false,
"type": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "IMMZC4",
"path": "IMMZC4",
"short": "IMMZ.C4.Create client record",
"definition": "Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient"
}
]
},
{
"id": "IMMZC4.uniqueIdentifier",
"path": "IMMZC4.uniqueIdentifier",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE1"
}
],
"short": "Unique identifier",
"definition": "Unique identifier for the client, according to the policies applicable to each country. There can be more than one unique identifier used to link records (e.g. national identification [ID], health ID, immunization information system ID, medical record ID)",
"min": 1,
"max": "1",
"base": {
"path": "IMMZC4.uniqueIdentifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.identifier.value"
}
]
},
{
"id": "IMMZC4.name",
"path": "IMMZC4.name",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE2"
},
{
"system": "http://loinc.org",
"code": "54125-0",
"display": "Patient name"
},
{
"system": "http://snomed.info/sct",
"code": "371484003",
"display": "Patient name (observable entity)"
}
],
"short": "Name",
"definition": "The full name of the client",
"min": 1,
"max": "1",
"base": {
"path": "IMMZC4.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.name.text"
}
]
},
{
"id": "IMMZC4.firstName",
"path": "IMMZC4.firstName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE3"
},
{
"system": "http://loinc.org",
"code": "45392-8",
"display": "First name"
},
{
"system": "http://snomed.info/sct",
"code": "184095009",
"display": "Patient forename (observable entity)"
}
],
"short": "First name",
"definition": "Client's first name or given name",
"min": 0,
"max": "1",
"base": {
"path": "IMMZC4.firstName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.name.given"
}
]
},
{
"id": "IMMZC4.familyName",
"path": "IMMZC4.familyName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE4"
},
{
"system": "http://loinc.org",
"code": "45394-4",
"display": "Last name"
},
{
"system": "http://snomed.info/sct",
"code": "184096005",
"display": "Patient surname (observable entity)"
}
],
"short": "Family name",
"definition": "Client's family name or last name",
"min": 0,
"max": "1",
"base": {
"path": "IMMZC4.familyName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.name.family"
}
]
},
{
"id": "IMMZC4.sex",
"path": "IMMZC4.sex",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE5"
},
{
"system": "http://loinc.org",
"code": "46098-0",
"display": "Sex"
},
{
"system": "http://snomed.info/sct",
"code": "184100006",
"display": "Patient sex (observable entity)"
}
],
"short": "Sex",
"definition": "Documentation of a specific instance of sex information for the client",
"min": 1,
"max": "1",
"base": {
"path": "IMMZC4.sex",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5"
},
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.gender"
}
]
},
{
"id": "IMMZC4.dateOfBirth",
"path": "IMMZC4.dateOfBirth",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE10"
},
{
"system": "http://loinc.org",
"code": "21112-8",
"display": "Birth date"
},
{
"system": "http://snomed.info/sct",
"code": "184099003",
"display": "Date of birth (observable entity)"
}
],
"short": "Date of birth",
"definition": "Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes",
"min": 1,
"max": "1",
"base": {
"path": "IMMZC4.dateOfBirth",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.birthDate"
}
]
},
{
"id": "IMMZC4.age",
"path": "IMMZC4.age",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE13"
},
{
"system": "http://loinc.org",
"code": "63900-5",
"display": "Current age or age at death"
}
],
"short": "Age",
"definition": "The client's calculated age (presented as number of years, months, weeks, days) based on the DOB and the visit date",
"min": 0,
"max": "1",
"base": {
"path": "IMMZC4.age",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-age-1",
"severity": "error",
"human": "Required if date of birth is entered.",
"expression": "not(%resource.dateOfBirth.exists()) or $this.exists()",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
]
},
{
"id": "IMMZC4.caregiversMultiple",
"path": "IMMZC4.caregiversMultiple",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE14"
},
{
"system": "http://snomed.info/sct",
"code": "184140000",
"display": "Caregiver details (observable entity)"
}
],
"short": "Caregivers (multiple)",
"definition": "Details of the client's caregiver (person) who could be next of kin (e.g. partner, husband, mother, sibling, etc.)",
"min": 0,
"max": "*",
"base": {
"path": "IMMZC4.caregiversMultiple",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.id",
"path": "IMMZC4.caregiversMultiple.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.extension",
"path": "IMMZC4.caregiversMultiple.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.modifierExtension",
"path": "IMMZC4.caregiversMultiple.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.caregiversFullName",
"path": "IMMZC4.caregiversMultiple.caregiversFullName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE15"
},
{
"system": "http://snomed.info/sct",
"code": "184140000",
"display": "Caregiver details (observable entity)"
}
],
"short": "Caregiver's full name",
"definition": "The full name of the client's caregiver",
"min": 0,
"max": "1",
"base": {
"path": "IMMZC4.caregiversMultiple.caregiversFullName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson.name.text"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.caregiversFirstName",
"path": "IMMZC4.caregiversMultiple.caregiversFirstName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE16"
},
{
"system": "http://loinc.org",
"code": "45392-8",
"display": "First name"
}
],
"short": "Caregiver's first name",
"definition": "First or given name of the client's caregiver",
"min": 0,
"max": "1",
"base": {
"path": "IMMZC4.caregiversMultiple.caregiversFirstName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson.name.given"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.caregiversFamilyName",
"path": "IMMZC4.caregiversMultiple.caregiversFamilyName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE17"
},
{
"system": "http://loinc.org",
"code": "45394-4",
"display": "Last name"
}
],
"short": "Caregiver's family name",
"definition": "Family name or last name of the client's caregiver",
"min": 0,
"max": "1",
"base": {
"path": "IMMZC4.caregiversMultiple.caregiversFamilyName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson.name.family"
}
]
},
{
"id": "IMMZC4.contactPhoneNumber",
"path": "IMMZC4.contactPhoneNumber",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE18"
},
{
"system": "http://loinc.org",
"code": "42077-8",
"display": "Patient Phone number"
},
{
"system": "http://snomed.info/sct",
"code": "184103008",
"display": "Patient telephone number (observable entity)"
}
],
"short": "Contact phone number",
"definition": "Client's phone number; can be a landline or a mobile phone number",
"min": 1,
"max": "1",
"base": {
"path": "IMMZC4.contactPhoneNumber",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.telecom.value"
}
]
},
{
"id": "IMMZC4.address",
"path": "IMMZC4.address",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE19"
},
{
"system": "http://loinc.org",
"code": "56799-0",
"display": "Address"
},
{
"system": "http://snomed.info/sct",
"code": "184097001",
"display": "Patient address (observable entity)"
}
],
"short": "Address",
"definition": "Client's home address or address that the client is consenting to disclose",
"min": 1,
"max": "1",
"base": {
"path": "IMMZC4.address",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.address.text"
}
]
}
]
},
"differential": {
"element": [
{
"id": "IMMZC4",
"path": "IMMZC4",
"short": "IMMZ.C4.Create client record",
"definition": "Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.",
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient"
}
]
},
{
"id": "IMMZC4.uniqueIdentifier",
"path": "IMMZC4.uniqueIdentifier",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE1"
}
],
"short": "Unique identifier",
"definition": "Unique identifier for the client, according to the policies applicable to each country. There can be more than one unique identifier used to link records (e.g. national identification [ID], health ID, immunization information system ID, medical record ID)",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.identifier.value"
}
]
},
{
"id": "IMMZC4.name",
"path": "IMMZC4.name",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE2"
},
{
"system": "http://loinc.org",
"code": "54125-0",
"display": "Patient name"
},
{
"system": "http://snomed.info/sct",
"code": "371484003",
"display": "Patient name (observable entity)"
}
],
"short": "Name",
"definition": "The full name of the client",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.name.text"
}
]
},
{
"id": "IMMZC4.firstName",
"path": "IMMZC4.firstName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE3"
},
{
"system": "http://loinc.org",
"code": "45392-8",
"display": "First name"
},
{
"system": "http://snomed.info/sct",
"code": "184095009",
"display": "Patient forename (observable entity)"
}
],
"short": "First name",
"definition": "Client's first name or given name",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.name.given"
}
]
},
{
"id": "IMMZC4.familyName",
"path": "IMMZC4.familyName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE4"
},
{
"system": "http://loinc.org",
"code": "45394-4",
"display": "Last name"
},
{
"system": "http://snomed.info/sct",
"code": "184096005",
"display": "Patient surname (observable entity)"
}
],
"short": "Family name",
"definition": "Client's family name or last name",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.name.family"
}
]
},
{
"id": "IMMZC4.sex",
"path": "IMMZC4.sex",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE5"
},
{
"system": "http://loinc.org",
"code": "46098-0",
"display": "Sex"
},
{
"system": "http://snomed.info/sct",
"code": "184100006",
"display": "Patient sex (observable entity)"
}
],
"short": "Sex",
"definition": "Documentation of a specific instance of sex information for the client",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5"
},
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.gender"
}
]
},
{
"id": "IMMZC4.dateOfBirth",
"path": "IMMZC4.dateOfBirth",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE10"
},
{
"system": "http://loinc.org",
"code": "21112-8",
"display": "Birth date"
},
{
"system": "http://snomed.info/sct",
"code": "184099003",
"display": "Date of birth (observable entity)"
}
],
"short": "Date of birth",
"definition": "Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.birthDate"
}
]
},
{
"id": "IMMZC4.age",
"path": "IMMZC4.age",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE13"
},
{
"system": "http://loinc.org",
"code": "63900-5",
"display": "Current age or age at death"
}
],
"short": "Age",
"definition": "The client's calculated age (presented as number of years, months, weeks, days) based on the DOB and the visit date",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-age-1",
"severity": "error",
"human": "Required if date of birth is entered.",
"expression": "not(%resource.dateOfBirth.exists()) or $this.exists()",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
]
},
{
"id": "IMMZC4.caregiversMultiple",
"path": "IMMZC4.caregiversMultiple",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE14"
},
{
"system": "http://snomed.info/sct",
"code": "184140000",
"display": "Caregiver details (observable entity)"
}
],
"short": "Caregivers (multiple)",
"definition": "Details of the client's caregiver (person) who could be next of kin (e.g. partner, husband, mother, sibling, etc.)",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.caregiversFullName",
"path": "IMMZC4.caregiversMultiple.caregiversFullName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE15"
},
{
"system": "http://snomed.info/sct",
"code": "184140000",
"display": "Caregiver details (observable entity)"
}
],
"short": "Caregiver's full name",
"definition": "The full name of the client's caregiver",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson.name.text"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.caregiversFirstName",
"path": "IMMZC4.caregiversMultiple.caregiversFirstName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE16"
},
{
"system": "http://loinc.org",
"code": "45392-8",
"display": "First name"
}
],
"short": "Caregiver's first name",
"definition": "First or given name of the client's caregiver",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson.name.given"
}
]
},
{
"id": "IMMZC4.caregiversMultiple.caregiversFamilyName",
"path": "IMMZC4.caregiversMultiple.caregiversFamilyName",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE17"
},
{
"system": "http://loinc.org",
"code": "45394-4",
"display": "Last name"
}
],
"short": "Caregiver's family name",
"definition": "Family name or last name of the client's caregiver",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "IMMZ-C-name-1",
"severity": "error",
"human": "Only letters and special characters (period, dash) allowed.",
"expression": "$this.matches('[A-Za-z-.]*')",
"source": "http://smart.who.int/immunizations/StructureDefinition/IMMZC4"
}
],
"mapping": [
{
"identity": "IMMZC4.to.RelatedPerson",
"map": "RelatedPerson.name.family"
}
]
},
{
"id": "IMMZC4.contactPhoneNumber",
"path": "IMMZC4.contactPhoneNumber",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE18"
},
{
"system": "http://loinc.org",
"code": "42077-8",
"display": "Patient Phone number"
},
{
"system": "http://snomed.info/sct",
"code": "184103008",
"display": "Patient telephone number (observable entity)"
}
],
"short": "Contact phone number",
"definition": "Client's phone number; can be a landline or a mobile phone number",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.telecom.value"
}
]
},
{
"id": "IMMZC4.address",
"path": "IMMZC4.address",
"code": [
{
"system": "http://smart.who.int/immunizations/CodeSystem/IMMZ.C",
"code": "DE19"
},
{
"system": "http://loinc.org",
"code": "56799-0",
"display": "Address"
},
{
"system": "http://snomed.info/sct",
"code": "184097001",
"display": "Patient address (observable entity)"
}
],
"short": "Address",
"definition": "Client's home address or address that the client is consenting to disclose",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "IMMZC4.to.Patient",
"map": "Patient.address.text"
}
]
}
]
}
}