SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-icvp/tree/selective-disclosure and changes regularly. See the Directory of published versions
Logical Model: DVC Vaccine Details with Selective Disclosure
| Official URL: http://smart.who.int/icvp/StructureDefinition/VaccineDetailsSD | Version: 0.1.0 | |||
| Draft as of 2025-02-11 | Computable Name: VaccineDetailsSD | |||
DVC Vaccine Details with Selective Disclosure
Usage:
- This Logical Model is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  VaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:vaccineProduct, date, issuer, clinicianName, batchNo, validityPeriod DVC - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
  vaccineProduct |
1..1 | Identifier | Vaccine Product | |
 date |
1..1 | date | Date | |
  issuer |
0..1 | Reference(Organization) | Issuing Organization | |
 @id |
0..1 | string | Unique id for inter-element referencing | |
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
  SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
 display |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| VaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| must-have-issuer-or-clinician | error | VaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from VaccineDetails
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VaccineDetails |
0..* | VaccineDetails | Elements defined in Ancestors:vaccineProduct, date, issuer, clinicianName, batchNo, validityPeriod DVC - Vaccine Details Instances of this logical model can be the target of a Reference | |
| issuer |
||||
  Slices for extension |
Content/Rules for all slices | |||
 SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| clinicianName |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:vaccineProduct, date, issuer, clinicianName, batchNo, validityPeriod DVC - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
| vaccineProduct |
1..1 | Identifier | Vaccine Product | |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| VaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| must-have-issuer-or-clinician | error | VaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from VaccineDetails
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:vaccineProduct, date, issuer, clinicianName, batchNo, validityPeriod DVC - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
| vaccineProduct |
1..1 | Identifier | Vaccine Product | |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| VaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| must-have-issuer-or-clinician | error | VaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
Differential View
This structure is derived from VaccineDetails
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VaccineDetails |
0..* | VaccineDetails | Elements defined in Ancestors:vaccineProduct, date, issuer, clinicianName, batchNo, validityPeriod DVC - Vaccine Details Instances of this logical model can be the target of a Reference | |
| issuer |
||||
| Slices for extension |
Content/Rules for all slices | |||
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| clinicianName |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:vaccineProduct, date, issuer, clinicianName, batchNo, validityPeriod DVC - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
| vaccineProduct |
1..1 | Identifier | Vaccine Product | |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| SelectiveDisclosureJWT |
0..1 | boolean | Extension URL: http://smart.who.int/icvp/StructureDefinition/SelectiveDisclosureJWT | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| VaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| must-have-issuer-or-clinician | error | VaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from VaccineDetails