IMMZC4
type: StructureDefinition
node role: treeRoot
id:
  v: IMMZC4
meta:
  profile:
    v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition
    l: crmi-shareablestructuredefinition
  profile:
    v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition
    l: crmi-publishablestructuredefinition
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition IMMZC4 Profiles: CRMI Shareable StructureDefinition, CRMI Publishable StructureDefinition Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> IMMZC4 0..* Base IMMZ.C4.Create client record #xD; uniqueIdentifier 1..1 string Unique identifier #xD; name C 1..1 string Name Constraints: IMMZ-C-name-1 #xD; firstName C 0..1 string First name Constraints: IMMZ-C-name-1 #xD; familyName C 0..1 string Family name Constraints: IMMZ-C-name-1 #xD; sex 1..1 code Sex Binding: IMMZ.C.DE5 ValueSet for Sex (required) #xD; dateOfBirth 1..1 string Date of birth #xD; age C 0..1 string Age Constraints: IMMZ-C-age-1 #xD; caregiversMultiple 0..* BackboneElement Caregivers (multiple) #xD; caregiversFullName C 0..1 string Caregiver's full name Constraints: IMMZ-C-name-1 #xD; caregiversFirstName C 0..1 string Caregiver's first name Constraints: IMMZ-C-name-1 #xD; caregiversFamilyName C 0..1 string Caregiver's family name Constraints: IMMZ-C-name-1 #xD; contactPhoneNumber 1..1 string Contact phone number #xD; address 1..1 string Address #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
    l: cqf-knowledgeCapability
  value: Code
    v: shareable
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
    l: artifact-versionAlgorithm
  value: Coding
    system:
      v: http://hl7.org/fhir/version-algorithm
      l: version-algorithm
    code:
      v: semver
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
    l: artifact-versionPolicy
  value: CodeableConcept
    coding:
      system:
        v: http://terminology.hl7.org/CodeSystem/artifact-version-policy-codes
        l: artifact-version-policy-codes
      code:
        v: metadata
url:
  v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
  l: IMMZC4
version:
  v: 0.2.0
name:
  v: IMMZ_C4_Create_client_record
title:
  v: IMMZ.C4.Create client record
status:
  v: active
experimental:
  v: false
date:
  v: 2024-12-18
publisher:
  v: WHO
contact:
  name:
    v: WHO
  telecom:
    system:
      v: url
    value:
      v: http://who.int
description:
  v: Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: IMMZC4.to.Patient
  uri:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZPatient
    l: IMMZPatient
  name:
    v: Mapping from the IMMZ.C4 to the IMMZPatient profile
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  uri:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZCaregiver
    l: IMMZCaregiver
  name:
    v: Mapping from the IMMZ.C4 to the IMMZCaregiver (RelatedPerson) profile
kind:
  v: logical
abstract:
  v: false
type:
  v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
  l: IMMZC4
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: IMMZC4
    path:
      v: IMMZC4
    short:
      v: IMMZ.C4.Create client record
    definition:
      v: Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: IMMZC4.to.Patient
      map:
        v: Patient
  element:
    id:
      v: IMMZC4.uniqueIdentifier
    path:
      v: IMMZC4.uniqueIdentifier
    code:
      system:
        v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
        l: IMMZ.C
      code:
        v: DE1
    short:
      v: Unique identifier
    definition:
      v: 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:
      v: 1
    max:
      v: 1
    base:
      path:
        v: IMMZC4.uniqueIdentifier
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: string
        l: string
    mapping:
      identity:
        v: IMMZC4.to.Patient
      map:
        v: Patient.identifier.value
  element:
    id:
      v: IMMZC4.name
    path:
      v: IMMZC4.name
    code:
      system:
        v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
        l: IMMZ.C
      code:
        v: DE2
    code: https://loinc.org/rdf/54125-0
      system:
        v: http://loinc.org
        l: loinc.org
      code:
        v: 54125-0
      display:
        v: Patient name
    code: http://snomed.info/id/371484003
      system:
        v: http://snomed.info/sct
        l: sct
      code:
        v: 371484003
      display:
        v: Patient name (observable entity)
    short:
      v: Name
    definition:
      v: The full name of the client
    min:
      v: 1

v: 1

path:
  v: IMMZC4.name
min:
  v: 1
max:
  v: 1

code:
  v: string
  l: string

key:
  v: IMMZ-C-name-1
severity:
  v: error
human:
  v: Only letters and special characters (period, dash) allowed.
expression:
  v: $this.matches('[A-Za-z-.]*')
source:
  v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
  l: IMMZC4

identity:
  v: IMMZC4.to.Patient
map:
  v: Patient.name.text

id:
  v: IMMZC4.firstName
path:
  v: IMMZC4.firstName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE3
code: https://loinc.org/rdf/45392-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 45392-8
  display:
    v: First name
code: http://snomed.info/id/184095009
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184095009
  display:
    v: Patient forename (observable entity)
short:
  v: First name
definition:
  v: Client's first name or given name
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IMMZC4.firstName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.name.given

id:
  v: IMMZC4.familyName
path:
  v: IMMZC4.familyName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE4
code: https://loinc.org/rdf/45394-4
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 45394-4
  display:
    v: Last name
code: http://snomed.info/id/184096005
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184096005
  display:
    v: Patient surname (observable entity)
short:
  v: Family name
definition:
  v: Client's family name or last name
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IMMZC4.familyName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.name.family

id:
  v: IMMZC4.sex
path:
  v: IMMZC4.sex
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE5
code: https://loinc.org/rdf/46098-0
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 46098-0
  display:
    v: Sex
code: http://snomed.info/id/184100006
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184100006
  display:
    v: Patient sex (observable entity)
short:
  v: Sex
definition:
  v: Documentation of a specific instance of sex information for the client
min:
  v: 1
max:
  v: 1
base:
  path:
    v: IMMZC4.sex
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
    l: IMMZ.C.DE5
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.gender

id:
  v: IMMZC4.dateOfBirth
path:
  v: IMMZC4.dateOfBirth
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE10
code: https://loinc.org/rdf/21112-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 21112-8
  display:
    v: Birth date
code: http://snomed.info/id/184099003
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184099003
  display:
    v: Date of birth (observable entity)
short:
  v: Date of birth
definition:
  v: Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes
min:
  v: 1
max:
  v: 1
base:
  path:
    v: IMMZC4.dateOfBirth
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.birthDate

id:
  v: IMMZC4.age
path:
  v: IMMZC4.age
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE13
code: https://loinc.org/rdf/63900-5
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 63900-5
  display:
    v: Current age or age at death
short:
  v: Age
definition:
  v: The client's calculated age (presented as number of years, months, weeks, days) based on the DOB and the visit date
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IMMZC4.age
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-age-1
  severity:
    v: error
  human:
    v: Required if date of birth is entered.
  expression:
    v: not(%resource.dateOfBirth.exists()) or $this.exists()
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4

id:
  v: IMMZC4.caregiversMultiple
path:
  v: IMMZC4.caregiversMultiple
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE14
code: http://snomed.info/id/184140000
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184140000
  display:
    v: Caregiver details (observable entity)
short:
  v: Caregivers (multiple)
definition:
  v: Details of the client's caregiver (person) who could be next of kin (e.g. partner, husband, mother, sibling, etc.)
min:
  v: 0
max:
  v: *
base:
  path:
    v: IMMZC4.caregiversMultiple
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson

id:
  v: IMMZC4.caregiversMultiple.id
path:
  v: IMMZC4.caregiversMultiple.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: IMMZC4.caregiversMultiple.extension
path:
  v: IMMZC4.caregiversMultiple.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: IMMZC4.caregiversMultiple.modifierExtension
path:
  v: IMMZC4.caregiversMultiple.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: IMMZC4.caregiversMultiple.caregiversFullName
path:
  v: IMMZC4.caregiversMultiple.caregiversFullName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE15
code: http://snomed.info/id/184140000
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184140000
  display:
    v: Caregiver details (observable entity)
short:
  v: Caregiver's full name
definition:
  v: The full name of the client's caregiver
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IMMZC4.caregiversMultiple.caregiversFullName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson.name.text

id:
  v: IMMZC4.caregiversMultiple.caregiversFirstName
path:
  v: IMMZC4.caregiversMultiple.caregiversFirstName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE16
code: https://loinc.org/rdf/45392-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 45392-8
  display:
    v: First name
short:
  v: Caregiver's first name
definition:
  v: First or given name of the client's caregiver
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IMMZC4.caregiversMultiple.caregiversFirstName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson.name.given

id:
  v: IMMZC4.caregiversMultiple.caregiversFamilyName
path:
  v: IMMZC4.caregiversMultiple.caregiversFamilyName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE17
code: https://loinc.org/rdf/45394-4
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 45394-4
  display:
    v: Last name
short:
  v: Caregiver's family name
definition:
  v: Family name or last name of the client's caregiver
min:
  v: 0
max:
  v: 1
base:
  path:
    v: IMMZC4.caregiversMultiple.caregiversFamilyName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson.name.family

id:
  v: IMMZC4.contactPhoneNumber
path:
  v: IMMZC4.contactPhoneNumber
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE18
code: https://loinc.org/rdf/42077-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 42077-8
  display:
    v: Patient Phone number
code: http://snomed.info/id/184103008
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184103008
  display:
    v: Patient telephone number (observable entity)
short:
  v: Contact phone number
definition:
  v: Client's phone number; can be a landline or a mobile phone number
min:
  v: 1
max:
  v: 1
base:
  path:
    v: IMMZC4.contactPhoneNumber
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.telecom.value

id:
  v: IMMZC4.address
path:
  v: IMMZC4.address
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE19
code: https://loinc.org/rdf/56799-0
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 56799-0
  display:
    v: Address
code: http://snomed.info/id/184097001
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184097001
  display:
    v: Patient address (observable entity)
short:
  v: Address
definition:
  v: Client's home address or address that the client is consenting to disclose
min:
  v: 1
max:
  v: 1
base:
  path:
    v: IMMZC4.address
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.address.text

element:
  id:
    v: IMMZC4
  path:
    v: IMMZC4
  short:
    v: IMMZ.C4.Create client record
  definition:
    v: Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.
  mapping:
    identity:
      v: IMMZC4.to.Patient
    map:
      v: Patient
element:
  id:
    v: IMMZC4.uniqueIdentifier
  path:
    v: IMMZC4.uniqueIdentifier
  code:
    system:
      v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
      l: IMMZ.C
    code:
      v: DE1
  short:
    v: Unique identifier
  definition:
    v: 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:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  mapping:
    identity:
      v: IMMZC4.to.Patient
    map:
      v: Patient.identifier.value
element:
  id:
    v: IMMZC4.name
  path:
    v: IMMZC4.name
  code:
    system:
      v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
      l: IMMZ.C
    code:
      v: DE2
  code: https://loinc.org/rdf/54125-0
    system:
      v: http://loinc.org
      l: loinc.org
    code:
      v: 54125-0
    display:
      v: Patient name
  code: http://snomed.info/id/371484003
    system:
      v: http://snomed.info/sct
      l: sct
    code:
      v: 371484003
    display:
      v: Patient name (observable entity)
  short:
    v: Name
  definition:
    v: The full name of the client
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  constraint:
    key:
      v: IMMZ-C-name-1
    severity:
      v: error
    human:
      v: Only letters and special characters (period, dash) allowed.
    expression:
      v: $this.matches('[A-Za-z-.]*')
    source:
      v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
      l: IMMZC4
  mapping:
    identity:
      v: IMMZC4.to.Patient
    map:
      v: Patient.name.text
element:
  id:
    v: IMMZC4.firstName
  path:
    v: IMMZC4.firstName
  code:
    system:
      v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
      l: IMMZ.C
    code:
      v: DE3
  code: https://loinc.org/rdf/45392-8
    system:
      v: http://loinc.org
      l: loinc.org
    code:
      v: 45392-8
    display:
      v: First name
  code: http://snomed.info/id/184095009
    system:
      v: http://snomed.info/sct
      l: sct
    code:
      v: 184095009
    display:
      v: Patient forename (observable entity)
  short:
    v: First name
  definition:
    v: Client's first name or given name
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  constraint:
    key:
      v: IMMZ-C-name-1
    severity:
      v: error
    human:
      v: Only letters and special characters (period, dash) allowed.
    expression:
      v: $this.matches('[A-Za-z-.]*')
    source:
      v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
      l: IMMZC4
  mapping:
    identity:
      v: IMMZC4.to.Patient
    map:
      v: Patient.name.given
element:
  id:
    v: IMMZC4.familyName
  path:
    v: IMMZC4.familyName
  code:
    system:
      v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
      l: IMMZ.C
    code:
      v: DE4
  code: https://loinc.org/rdf/45394-4
    system:
      v: http://loinc.org
      l: loinc.org
    code:
      v: 45394-4
    display:
      v: Last name
  code: http://snomed.info/id/184096005
    system:
      v: http://snomed.info/sct
      l: sct
    code:
      v: 184096005
    display:
      v: Patient surname (observable entity)
  short:
    v: Family name
  definition:
    v: Client's family name or last name
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  constraint:
    key:
      v: IMMZ-C-name-1
    severity:
      v: error
    human:
      v: Only letters and special characters (period, dash) allowed.
    expression:
      v: $this.matches('[A-Za-z-.]*')

identity:
  v: IMMZC4.to.Patient
map:
  v: Patient.name.family

id:
  v: IMMZC4.sex
path:
  v: IMMZC4.sex
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE5
code: https://loinc.org/rdf/46098-0
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 46098-0
  display:
    v: Sex
code: http://snomed.info/id/184100006
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184100006
  display:
    v: Patient sex (observable entity)
short:
  v: Sex
definition:
  v: Documentation of a specific instance of sex information for the client
min:
  v: 1
max:
  v: 1
type:
  code:
    v: code
    l: code
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
    l: IMMZ.C.DE5
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.gender

id:
  v: IMMZC4.dateOfBirth
path:
  v: IMMZC4.dateOfBirth
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE10
code: https://loinc.org/rdf/21112-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 21112-8
  display:
    v: Birth date
code: http://snomed.info/id/184099003
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184099003
  display:
    v: Date of birth (observable entity)
short:
  v: Date of birth
definition:
  v: Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes
min:
  v: 1
max:
  v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.birthDate

id:
  v: IMMZC4.age
path:
  v: IMMZC4.age
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE13
code: https://loinc.org/rdf/63900-5
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 63900-5
  display:
    v: Current age or age at death
short:
  v: Age
definition:
  v: The client's calculated age (presented as number of years, months, weeks, days) based on the DOB and the visit date
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-age-1
  severity:
    v: error
  human:
    v: Required if date of birth is entered.
  expression:
    v: not(%resource.dateOfBirth.exists()) or $this.exists()
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4

id:
  v: IMMZC4.caregiversMultiple
path:
  v: IMMZC4.caregiversMultiple
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE14
code: http://snomed.info/id/184140000
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184140000
  display:
    v: Caregiver details (observable entity)
short:
  v: Caregivers (multiple)
definition:
  v: Details of the client's caregiver (person) who could be next of kin (e.g. partner, husband, mother, sibling, etc.)
min:
  v: 0
max:
  v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson

id:
  v: IMMZC4.caregiversMultiple.caregiversFullName
path:
  v: IMMZC4.caregiversMultiple.caregiversFullName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE15
code: http://snomed.info/id/184140000
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184140000
  display:
    v: Caregiver details (observable entity)
short:
  v: Caregiver's full name
definition:
  v: The full name of the client's caregiver
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson.name.text

id:
  v: IMMZC4.caregiversMultiple.caregiversFirstName
path:
  v: IMMZC4.caregiversMultiple.caregiversFirstName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE16
code: https://loinc.org/rdf/45392-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 45392-8
  display:
    v: First name
short:
  v: Caregiver's first name
definition:
  v: First or given name of the client's caregiver
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson.name.given

id:
  v: IMMZC4.caregiversMultiple.caregiversFamilyName
path:
  v: IMMZC4.caregiversMultiple.caregiversFamilyName
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE17
code: https://loinc.org/rdf/45394-4
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 45394-4
  display:
    v: Last name
short:
  v: Caregiver's family name
definition:
  v: Family name or last name of the client's caregiver
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: IMMZ-C-name-1
  severity:
    v: error
  human:
    v: Only letters and special characters (period, dash) allowed.
  expression:
    v: $this.matches('[A-Za-z-.]*')
  source:
    v: http://smart.who.int/immunizations/StructureDefinition/IMMZC4
    l: IMMZC4
mapping:
  identity:
    v: IMMZC4.to.RelatedPerson
  map:
    v: RelatedPerson.name.family

id:
  v: IMMZC4.contactPhoneNumber
path:
  v: IMMZC4.contactPhoneNumber
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE18
code: https://loinc.org/rdf/42077-8
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 42077-8
  display:
    v: Patient Phone number
code: http://snomed.info/id/184103008
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184103008
  display:
    v: Patient telephone number (observable entity)
short:
  v: Contact phone number
definition:
  v: Client's phone number; can be a landline or a mobile phone number
min:
  v: 1
max:
  v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.telecom.value

id:
  v: IMMZC4.address
path:
  v: IMMZC4.address
code:
  system:
    v: http://smart.who.int/immunizations/CodeSystem/IMMZ.C
    l: IMMZ.C
  code:
    v: DE19
code: https://loinc.org/rdf/56799-0
  system:
    v: http://loinc.org
    l: loinc.org
  code:
    v: 56799-0
  display:
    v: Address
code: http://snomed.info/id/184097001
  system:
    v: http://snomed.info/sct
    l: sct
  code:
    v: 184097001
  display:
    v: Patient address (observable entity)
short:
  v: Address
definition:
  v: Client's home address or address that the client is consenting to disclose
min:
  v: 1
max:
  v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: IMMZC4.to.Patient
  map:
    v: Patient.address.text