The data dictionary lists the data each journey records or exchanges, as the WHO SMART Guidelines DAK does in its component 5: one data set per step that writes or reads it, each a FHIR logical model whose elements carry a code (TD.<data set>.DE<nn>, CodeSystem TrustDemoDataElements), a definition, a cardinality and, where the guide has a code list, a binding. Each model’s mapping realisation says where this guide realises the element: in a profile or example, in the DVC payload of WHO SMART Trust PHW (DVCMinPreQual), or in a CWT or COSE field. The data elements are read by the decision-support logic and counted by the indicators.

The source is dak/data-dictionary.json; the guide’s logical models, code lists and this page are generated from it. Every person and value in the examples is fictional.

Data set Journey steps Logical model Realised by
TD.J1 Birth-dose DVC J1 Issue the newborn’s birth-dose DVCs in Country A: Build one DVCMinPreQual payload per dose (Task_Payload); Prepare: CWT claims and the COSE Sig_structure (Task_Prepare); Sign the bytes with XXR’s DSC key (Task_Sign) TrustDemoDdBirthDoseDvc StructureDefinition TrustDemoTaifafekiPatient, StructureDefinition TrustDemoTaifafekiImmunization, Patient TrustDemoTaifafekiSomsak, Immunization TrustDemoJ1HepB, Immunization TrustDemoJ1Bcg
TD.J2A Newborn registration on a home visit J2 Discover and refer an unregistered infant in Country B: Read each DVC unverified (triage) (Task_Read); Add the infant; save doses as reported (Task_Register) TrustDemoDdChwRegistration Questionnaire TrustDemoHouseholdRegistration, StructureDefinition TrustDemoOnesaRegistration, StructureDefinition TrustDemoOnesaHousehold, StructureDefinition TrustDemoOnesaPatient, StructureDefinition TrustDemoOnesaReportedImmunization, QuestionnaireResponse TrustDemoJ2Registration, Group TrustDemoHousehold, Immunization TrustDemoJ2HepBReported, Immunization TrustDemoJ2BcgReported
TD.J2B Referral for verification J2 Discover and refer an unregistered infant in Country B: Create a referral to the home clinic for verification (Task_Refer)
J3 Verify, import and schedule at the home clinic: Scan the QRs and open the referral (Task_Scan)
TrustDemoDdChwReferral StructureDefinition TrustDemoOnesaReferral, ServiceRequest TrustDemoJ2Referral
TD.J3A DVC verification and import J3 Verify, import and schedule at the home clinic: Verify each HCERT against the trust list (Task_Verify); Every DVC verified? (Gateway_Verified); Note the failure; decide doses by policy (Task_Unverified); Import the doses as FHIR Immunization resources (Task_Import) TrustDemoDdDvcVerification StructureDefinition TrustDemoOnesaDvcVerification, StructureDefinition TrustDemoOnesaImmunization, Provenance TrustDemoJ3Verification, Immunization TrustDemoJ3HepB, Immunization TrustDemoJ3Bcg
TD.J3B Imported dose and schedule J3 Verify, import and schedule at the home clinic: Add national codes beside foreign ones (Task_Map); Evaluate the national schedule (Task_Schedule); Give due doses and book the next visit (Task_Plan) TrustDemoDdImportedDose StructureDefinition TrustDemoOnesaImmunization, ConceptMap TrustDemoProductToOnesaEpi, Provenance TrustDemoJ3Adjudication, PlanDefinition TrustDemoOnesaInfantSchedule, ImmunizationRecommendation TrustDemoJ3Recommendation, Task TrustDemoJ3Reminder
TD.J40 Shared link and consent J4.0 Issue the family’s records to one phone as VHLs: Assemble each member’s IPS and DVCs (Task_Assemble); Encrypt, publish a passcode manifest (Task_Share) TrustDemoDdVhlShare Consent TrustDemoJ4Consent, Bundle TrustDemoJ4Ips
TD.J41 Access to a shared link J4.1 Read a family member’s records at the point of care abroad: Request the manifest (ITI-YY5), signed (Task_Fetch); Check passcode, log access, return manifest (Task_Release) TrustDemoDdVhlAccess StructureDefinition TrustDemoOnesaVhlAccess, AuditEvent TrustDemoJ41Access, AuditEvent TrustDemoJ41WrongPasscode

TD.J1 Birth-dose DVC

What the birth hospital records for each birth dose and signs into one Digital Vaccination Certificate (DVC, an HCERT) per dose: the payload, the CWT claims and the key that signs it.

Code Element Label Card. Type Definition Binding Realised in
TD.J1.DE01 name Name 1..1 string The child’s name as the birth hospital records it.   TrustDemoTaifafekiPatient: Patient.name; DVCMinPreQual.n
TD.J1.DE02 dateOfBirth Date of birth 1..1 date The child’s date of birth.   TrustDemoTaifafekiPatient: Patient.birthDate; DVCMinPreQual.dob
TD.J1.DE03 guardianName Parent or guardian name 0..1 string The parent or guardian, for a subject with no identity document such as a newborn (STT-PAY-005).   DVCMinPreQual.gn
TD.J1.DE04 hospitalNumber Hospital number 1..1 Identifier The birth hospital’s own identifier for the child. It is not carried in the DVC.   TrustDemoTaifafekiPatient: Patient.identifier[hn]
TD.J1.DE05 vaccineProduct Vaccine product 1..1 Coding The product given, in the issuer’s product coding (illustrative PreQual-style codes). TrustDemoVaccineProducts (required) TrustDemoTaifafekiImmunization: Immunization.vaccineCode.coding[product]; DVCMinPreQual.v.vp
TD.J1.DE06 dateOfVaccination Date of vaccination 1..1 date The date the dose was given. The hospital record holds the time as well; the DVC carries the date.   TrustDemoTaifafekiImmunization: Immunization.occurrenceDateTime; DVCMinPreQual.v.dt
TD.J1.DE07 batchNumber Batch number 1..1 string The batch (lot) of the vaccine given.   TrustDemoTaifafekiImmunization: Immunization.lotNumber; DVCMinPreQual.v.bo
TD.J1.DE08 doseNumber Dose number 1..1 string The dose’s number in its series. Recorded by the hospital; the minimal DVC payload does not carry it.   TrustDemoTaifafekiImmunization: Immunization.protocolApplied.doseNumber
TD.J1.DE09 clinician Supervising clinician 0..1 string The clinician who gave or supervised the dose.   TrustDemoTaifafekiImmunization: Immunization.performer.actor; DVCMinPreQual.v.cn
TD.J1.DE10 issuerCountry Issuing country 1..1 code The trust-network participant whose key signs the DVC (J1: XXR).   CWT claim 1 (iss)
TD.J1.DE11 issuedAt Issued at 1..1 dateTime When the DVC was signed.   CWT claim 6 (iat)
TD.J1.DE12 expiresAt Expires at 0..1 dateTime When the DVC stops verifying, where the issuer sets an expiry.   CWT claim 4 (exp)
TD.J1.DE13 keyId Key identifier (kid) 1..1 string Identifies the document signer certificate on the trust list that verifies the DVC (J1: 916ffa567c0f44a2).   COSE header kid

TD.J2A Newborn registration on a home visit

What the community health worker records offline when she finds a newborn missing from the household roster: the registration form’s answers and each dose read from a foreign card without verifying it.

Code Element Label Card. Type Definition Binding Realised in
TD.J2A.DE01 householdId Household id 1..1 Identifier The household on the CHW’s roster that the child joins.   TrustDemoHouseholdRegistration item household; TrustDemoOnesaHousehold: Group.identifier[household]
TD.J2A.DE02 givenName Child’s given name 1..1 string The child’s given name.   TrustDemoHouseholdRegistration item given; TrustDemoOnesaPatient: Patient.name.given
TD.J2A.DE03 familyName Child’s family name 1..1 string The child’s family name.   TrustDemoHouseholdRegistration item family; TrustDemoOnesaPatient: Patient.name.family
TD.J2A.DE04 birthDate Date of birth 1..1 date The child’s date of birth.   TrustDemoHouseholdRegistration item birthDate; TrustDemoOnesaPatient: Patient.birthDate
TD.J2A.DE05 birthCountry Country of birth 0..1 string The country the child was born in, when abroad.   TrustDemoHouseholdRegistration item birthCountry
TD.J2A.DE06 foreignCardsHeld Foreign vaccination cards held 0..1 boolean Whether the family holds vaccination cards from abroad.   TrustDemoHouseholdRegistration item foreignCards
TD.J2A.DE07 temporaryId Temporary id 0..1 Identifier The id the child carries until civil registration catches up.   TrustDemoOnesaPatient: Patient.identifier[temporaryId]
TD.J2A.DE08 registeredBy Registered by 1..1 Reference(Practitioner) The community health worker who registered the child.   TrustDemoOnesaRegistration: QuestionnaireResponse.author
TD.J2A.DE09 registeredAt Registered at 1..1 dateTime When the registration was captured, on the phone, possibly offline.   TrustDemoOnesaRegistration: QuestionnaireResponse.authored
TD.J2A.DE10 informant Informant 0..1 Reference(RelatedPerson) The family member who gave the answers.   TrustDemoOnesaRegistration: QuestionnaireResponse.source
TD.J2A.DE11 reportedDose Dose read from a foreign card 0..* BackboneElement One dose read from a foreign DVC with the unverified triage read (STT-VER-011), saved as reported by the family.   TrustDemoOnesaReportedImmunization: Immunization
TD.J2A.DE12 reportedDose.vaccineProduct Vaccine product (as read) 1..1 Coding The issuer’s product code as read from the card; no national code is added yet. TrustDemoVaccineProducts (required) TrustDemoOnesaReportedImmunization: Immunization.vaccineCode
TD.J2A.DE13 reportedDose.dateOfVaccination Date of vaccination (as read) 1..1 date The date of vaccination as read from the card.   TrustDemoOnesaReportedImmunization: Immunization.occurrenceDateTime
TD.J2A.DE14 reportedDose.batchNumber Batch number (as read) 0..1 string The batch number as read from the card.   TrustDemoOnesaReportedImmunization: Immunization.lotNumber
TD.J2A.DE15 reportedDose.reportedBy Reported by 1..1 Reference(RelatedPerson) The family member who showed the card: the dose’s information source.   TrustDemoOnesaReportedImmunization: Immunization.informationSource
TD.J2A.DE16 reportedDose.outcome Record outcome 1..1 code Always reported-unverified for a triage read (decision table TD.DT.01); recorded as primarySource false with a note. TrustDemoDvcOutcomeVS (required) TrustDemoOnesaReportedImmunization: Immunization.primarySource = false; TrustDemoOnesaReportedImmunization: Immunization.note

TD.J2B Referral for verification

The community health worker’s referral of the child to the home clinic, to verify the foreign cards and fit the doses to the national schedule.

Code Element Label Card. Type Definition Binding Realised in
TD.J2B.DE01 child Child 1..1 Reference(Patient) The child referred.   TrustDemoOnesaReferral: ServiceRequest.subject
TD.J2B.DE02 referredBy Referred by 1..1 Reference(Practitioner) The community health worker who made the referral.   TrustDemoOnesaReferral: ServiceRequest.requester
TD.J2B.DE03 referredTo Referred to 1..1 Reference(Organization) The clinic that will verify the cards.   TrustDemoOnesaReferral: ServiceRequest.performer
TD.J2B.DE04 referredAt Referred at 1..1 dateTime When the referral was made.   TrustDemoOnesaReferral: ServiceRequest.authoredOn
TD.J2B.DE05 reason Reason 1..1 string Why the child is referred: unverified foreign vaccination cards.   TrustDemoOnesaReferral: ServiceRequest.reason.concept.text
TD.J2B.DE06 dosesToVerify Doses to verify 1..* Reference(Immunization) The reported doses the clinic is asked to verify.   TrustDemoOnesaReferral: ServiceRequest.supportingInfo
TD.J2B.DE07 status Referral status 1..1 code Active until the clinic records an outcome for every dose it lists, then completed (indicator TD.IND.03). http://hl7.org/fhir/ValueSet/request-status (required) TrustDemoOnesaReferral: ServiceRequest.status

TD.J3A DVC verification and import

What the clinic records when it verifies a foreign DVC against its cached copy of the trust list, and, when the DVC verifies, imports the dose in place of the reported one.

Code Element Label Card. Type Definition Binding Realised in
TD.J3A.DE01 keyId Key identifier (kid) 1..1 string The kid of the DVC verified, which names the signer’s certificate.   TrustDemoOnesaDvcVerification: Provenance.entity.what.display
TD.J3A.DE02 issuerCountry Issuing country 1..1 code The participant that signed the DVC (CWT iss).   TrustDemoOnesaDvcVerification: Provenance.entity.what.display
TD.J3A.DE03 verifiedAt Verified at 1..1 dateTime When the verification ran.   TrustDemoOnesaDvcVerification: Provenance.recorded
TD.J3A.DE04 verifier Verifier 1..1 Reference(Device) The system that verified the DVC.   TrustDemoOnesaDvcVerification: Provenance.agent (verifier)
TD.J3A.DE05 result Verification result 1..1 code The library’s typed result (STT-VER-008). TrustDemoVerificationResultVS (required) TrustDemoOnesaDvcVerification: Provenance.activity.text
TD.J3A.DE06 failedStep Failed step 0..1 code The step at which verification stopped, when it failed. TrustDemoVerificationStepVS (required) not yet realised in the examples (J3’s DVCs verify)
TD.J3A.DE07 failureReason Failure reason 0..1 code Why verification stopped, when it failed: the input of decision table TD.DT.01. TrustDemoVerificationFailureReasonVS (required) not yet realised in the examples (J3’s DVCs verify)
TD.J3A.DE08 trustListRefreshedAt Trust list refreshed at 0..1 dateTime When the verifier last refreshed its cached copy of the trust list; a signer added since then fails with KidNotFound (STT-VER-006).   not yet realised in the examples
TD.J3A.DE09 outcome Record outcome 1..1 code What the DVC becomes in the record (decision table TD.DT.01). TrustDemoDvcOutcomeVS (required) TrustDemoOnesaImmunization: Immunization.primarySource = true (verified); TrustDemoOnesaDvcVerification: Provenance
TD.J3A.DE10 importedDose Imported dose 0..1 Reference(Immunization) The dose recorded from the verified DVC.   TrustDemoOnesaDvcVerification: Provenance.target
TD.J3A.DE11 replacesReportedDose Reported dose replaced 0..* Reference(Immunization) The reported dose the verified one replaces.   TrustDemoOnesaDvcVerification: Provenance.entity (role removal)
TD.J3A.DE12 policy Trust policy 1..1 uri The trust framework the DVC was verified under.   TrustDemoOnesaDvcVerification: Provenance.policy

TD.J3B Imported dose and schedule

What the clinic records for each imported dose’s vaccine code, and what the national schedule finds due once the doses are counted.

Code Element Label Card. Type Definition Binding Realised in
TD.J3B.DE01 productCode Issuer’s product code 1..1 Coding The vaccine code as the issuer signed it; kept, never replaced (STD-SEM-001). TrustDemoVaccineProducts (required) TrustDemoOnesaImmunization: Immunization.vaccineCode.coding[product]
TD.J3B.DE02 scheduleCode National schedule code 0..1 Coding The national schedule’s antigen-and-dose code, added beside the product code. Absent for an unmapped dose, which the TrustDemoOnesaImmunization profile (onesaEpi 1..1) does not yet represent. TrustDemoOnesaEpiScheduleCodes (required) TrustDemoOnesaImmunization: Immunization.vaccineCode.coding[onesaEpi]
TD.J3B.DE03 mappingBasis Mapping basis 1..1 code How the schedule code was found (decision table TD.DT.02). TrustDemoCodeMappingBasisVS (required) TrustDemoProductToOnesaEpi: ConceptMap.group.element (concept-map); Provenance (clinician-confirmed), as TrustDemoJ3Adjudication
TD.J3B.DE04 confirmedBy Confirmed by 0..1 Reference(Practitioner) The clinician who confirmed an equivalent the map did not cover.   Provenance.agent (attester), as TrustDemoJ3Adjudication
TD.J3B.DE05 countsTowardSchedule Counts toward the schedule 1..1 boolean Whether the schedule counts the dose (decision table TD.DT.03): only doses from a primary source with a national schedule code.   ImmunizationRecommendation.recommendation.supportingImmunization
TD.J3B.DE06 dueDose Dose due 0..* BackboneElement A dose of the national schedule the evaluation finds due (decision table TD.DT.04).   ImmunizationRecommendation.recommendation, as TrustDemoJ3Recommendation
TD.J3B.DE07 dueDose.scheduleCode Schedule dose 1..1 Coding The schedule’s antigen-and-dose code of the dose due. TrustDemoOnesaEpiScheduleCodes (required) ImmunizationRecommendation.recommendation.vaccineCode
TD.J3B.DE08 dueDose.forecast Forecast status 1..1 code The forecast for the dose. http://hl7.org/fhir/ValueSet/immunization-recommendation-status (example) ImmunizationRecommendation.recommendation.forecastStatus
TD.J3B.DE09 dueDose.dueDate Due date 1..1 date The child’s date of birth plus the schedule action’s timing age.   ImmunizationRecommendation.recommendation.dateCriterion (LOINC 30980-7)
TD.J3B.DE10 reminder Reminder 0..1 Reference(Task) The reminder created for the next visit.   Task, as TrustDemoJ3Reminder

What the home country records when the holder shares a family member’s summary as a Verifiable Health Link (VHL): who may read what, for how long, and that a passcode protects it.

Code Element Label Card. Type Definition Binding Realised in
TD.J40.DE01 subject Subject 1..1 Reference(Patient) The family member whose summary is shared.   Consent.subject
TD.J40.DE02 holder Holder 1..1 Reference(RelatedPerson) The person who shares the link and decides who may open it.   Consent.grantor
TD.J40.DE03 custodian Custodian 1..1 Reference(Organization) The home-country service that hosts the record and checks every request.   Consent.controller
TD.J40.DE04 sharedDocument Shared document 1..1 Reference(Bundle) The patient summary the link releases.   Consent.provision.data.reference
TD.J40.DE05 validFrom Valid from 1..1 date The first day the link may be opened.   Consent.provision.period.start
TD.J40.DE06 validUntil Valid until 1..1 date The expiry the holder chose; after it the link releases nothing (STD-ACC-001).   Consent.provision.period.end
TD.J40.DE07 purpose Purpose 1..1 Coding The purpose of use the holder allows (J4: treatment).   Consent.provision.purpose
TD.J40.DE08 passcodeSet Passcode set 1..1 boolean Whether the holder protected the link with a passcode. The passcode itself is never stored in the record.   the link’s passcode flag (IHE ITI VHL); not in Consent
TD.J40.DE09 withdrawnAt Withdrawn at 0..1 dateTime When the holder withdrew the link, if they did.   Consent.status = inactive; not yet realised in the examples

What the home country logs for every request to open a shared link, released or refused.

Code Element Label Card. Type Definition Binding Realised in
TD.J41.DE01 requestedAt Requested at 1..1 dateTime When the request arrived.   TrustDemoOnesaVhlAccess: AuditEvent.recorded
TD.J41.DE02 requester Requester 1..1 Reference(Device) The receiving system abroad that asked for the manifest.   TrustDemoOnesaVhlAccess: AuditEvent.agent (IRCP).who
TD.J41.DE03 requesterAddress Requester network address 0..1 string Where the request came from.   TrustDemoOnesaVhlAccess: AuditEvent.agent.networkString
TD.J41.DE04 custodian Custodian 1..1 Reference(Device) The home-country gateway that answered and logged the request.   TrustDemoOnesaVhlAccess: AuditEvent.agent (CST).who; TrustDemoOnesaVhlAccess: AuditEvent.source.observer
TD.J41.DE05 patient Patient 1..1 Reference(Patient) Whose record was asked for.   TrustDemoOnesaVhlAccess: AuditEvent.entity (role Patient)
TD.J41.DE06 released Released 1..1 boolean Whether the manifest was released (decision table TD.DT.05).   TrustDemoOnesaVhlAccess: AuditEvent.outcome.code
TD.J41.DE07 outcome Audit outcome 1..1 code 0 when released; 4 (minor failure) when refused. http://hl7.org/fhir/ValueSet/audit-event-outcome (preferred) TrustDemoOnesaVhlAccess: AuditEvent.outcome.code
TD.J41.DE08 refusalReason Refusal reason 0..1 code Why nothing was released, when refused. TrustDemoVhlRefusalReasonVS (required) TrustDemoOnesaVhlAccess: AuditEvent.outcome.detail
TD.J41.DE09 consent Consent 0..1 Reference(Consent) The holder’s consent the request was checked against.   TrustDemoOnesaVhlAccess: AuditEvent.entity
TD.J41.DE10 document Document released 0..1 Reference(Bundle) The summary released, when released.   TrustDemoOnesaVhlAccess: AuditEvent.entity

Code lists

The code lists the data elements bind to, beside the vaccine code systems of the examples (TrustDemoVaccineProducts, TrustDemoOnesaEpiScheduleCodes) and FHIR’s own.

Code list Codes Description
Result of reading a DVC verified, failed, unverified What the HCERT library returns for one scanned DVC: a verified result, a failed result naming the step and reason (STT-VER-008), or the distinct result of the unverified triage read (STT-VER-011).
Verification steps prefix, base45, inflate, cose, header, trust-lookup, signature, key-usage, cwt, time, hcert, payload The steps of DVC verification in the order they run (STT-VER-001), as the HCERT library names them in its typed result (STT-VER-008).
Verification failure reasons BadPrefix, UnsupportedContextVersion, Base45Invalid, InflateFailed, LimitExceeded, CoseMalformed, HeaderInvalid, UnsupportedAlgorithm, KidNotFound, SignatureInvalid, KeyUsageMismatch, Expired, NotYetValid, HcertMissing, MultipleSubclaims, PayloadInvalid The closed set of reasons a DVC fails verification, shared by the Kotlin and Rust HCERT libraries (STT-VER-008).
What a scanned DVC becomes in the record verified, reported-unverified, rejected, not-read The outcome of decision table TD.DT.01 for one scanned DVC.
How an imported dose got its national schedule code concept-map, clinician-confirmed, unmapped, not-imported The outcome of decision table TD.DT.02 (STD-SEM-001).
Why a shared link released nothing withdrawn, expired, wrong-passcode The refusal reasons of decision table TD.DT.05 (STD-ACC-001).

Edit this page on GitHub