SMART ICVP
0.3.0 - ci-build

SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.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/main and changes regularly. See the Directory of published versions

Logical Model: DVC Icvp with Selective Disclosure

Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPSD Version: 0.3.0
Active as of 2025-10-30 Computable Name: ICVPSD

DVC Icvp with Selective Disclosure

Usages:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* ICVP ICVP
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... dob 1..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 date Primitive value for date
... sex 0..1 code Sex
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
... nid 0..1 Identifier National Identification Document
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... guardian 0..1 string Parent/Guardian
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... issuer 0..1 Reference(Organization) Document issuer
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... 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
... vaccineDetails 1..* ICVPVaccineDetailsSD Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.nid.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ICVP.nid.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ICVP.ndt Base extensible hl7VS-identifierType 📦2.0.0 THO v6.5
ICVP.issuer.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

API Information

DVC Icvp with Selective Disclosure API

DVC Icvp with Selective Disclosure

Version: 1.0.0

Endpoints

GET /StructureDefinition-ICVPSD.schema.json

JSON Schema definition for the Logical Model StructureDefinition-ICVPSD

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-ICVPSD.

Schema Definition

StructureDefinition-ICVPSD

Description: DVC Icvp with Selective Disclosure

Type: object

Schema ID: http://smart.who.int/base/StructureDefinition-ICVPSD.schema.json

Properties

  • resourceType (string): Resource type identifier for ICVPSD logical model
  • @context (unknown): JSON-LD context for this logical model with ValueSet vocabularies
  • @type (string): JSON-LD type identifier for ICVPSD logical model
  • ICVP (array): Data elements for the Model International Certificate of Vaccination or Prophylaxis.
  • name (string): The full name of the client
  • id (object): Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • value (object): The actual value
  • dob (string): Date of Birth
  • sex (string): Sex
  • nationality (string): Nationality
  • nid (object): National Identification Document
  • use (unknown): The purpose of this identifier.
  • type (string): The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
  • system (string): Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
  • period (object): Time period during which identifier is/was valid for use.
  • assigner (object): Organization that issued/manages the identifier.
  • ndt (unknown): National ID Document Type
  • guardian (string): Name of Parent or Guardian
  • issuer (object): Document issuer
  • reference (string): A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
  • identifier (object): An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
  • display (string): Plain text narrative that identifies the resource in addition to the resource reference.
  • vaccineDetails (array): Vaccine Details

Required fields: resourceType, name, dob, vaccineDetails

Full Schema (JSON)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-ICVPSD.schema.json",
  "title": "DVC Icvp with Selective Disclosure",
  "description": "DVC Icvp with Selective Disclosure",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "ICVPSD",
      "description": "Resource type identifier for ICVPSD logical model"
    },
    "@context": {
      "description": "JSON-LD context for this logical model with ValueSet vocabularies",
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "description": "URI reference to external JSON-LD context"
        },
        {
          "type": "object",
          "description": "Inline JSON-LD context",
          "properties": {
            "@version": {
              "type": "number",
              "const": 1.1
            },
            "fhir": {
              "type": "string",
              "const": "http://hl7.org/fhir/"
            }
          },
          "additionalProperties": {
            "type": "string",
            "format": "uri"
          }
        },
        {
          "type": "array",
          "description": "Array of JSON-LD context objects/URIs",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "object"
              }
            ]
          }
        }
      ]
    },
    "@type": {
      "type": "string",
      "description": "JSON-LD type identifier for ICVPSD logical model",
      "examples": [
        "LogicalModel-ICVPSD"
      ]
    },
    "ICVP": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR "
      },
      "description": "Data elements for the Model International Certificate of Vaccination or Prophylaxis."
    },
    "name": {
      "type": "string",
      "description": "The full name of the client"
    },
    "id": {
      "type": "object",
      "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
    },
    "value": {
      "type": "object",
      "description": "The actual value"
    },
    "dob": {
      "type": "string",
      "format": "date",
      "description": "Date of Birth"
    },
    "sex": {
      "type": "string",
      "description": "Sex"
    },
    "nationality": {
      "type": "string",
      "description": "Nationality"
    },
    "nid": {
      "type": "object",
      "description": "National Identification Document"
    },
    "use": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet identifier-use|4.0.1 (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet identifier-use|4.0.1 (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-identifier-use|4.0.1.jsonld",
              "description": "JSON-LD type reference to ValueSet identifier-use|4.0.1"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet identifier-use|4.0.1"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "The purpose of this identifier."
    },
    "type": {
      "type": "string",
      "format": "uri",
      "description": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)."
    },
    "system": {
      "type": "string",
      "format": "uri",
      "description": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique."
    },
    "period": {
      "type": "object",
      "description": "Time period during which identifier is/was valid for use."
    },
    "assigner": {
      "type": "object",
      "description": "Organization that issued/manages the identifier."
    },
    "ndt": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet v2-0203 (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet v2-0203 (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-v2-0203.jsonld",
              "description": "JSON-LD type reference to ValueSet v2-0203"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet v2-0203"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "National ID Document Type"
    },
    "guardian": {
      "type": "string",
      "description": "Name of Parent or Guardian"
    },
    "issuer": {
      "type": "object",
      "description": "Document issuer"
    },
    "reference": {
      "type": "string",
      "description": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources."
    },
    "identifier": {
      "type": "object",
      "description": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference."
    },
    "display": {
      "type": "string",
      "description": "Plain text narrative that identifies the resource in addition to the resource reference."
    },
    "vaccineDetails": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-ICVPVaccineDetails.schema.json"
      },
      "minItems": 1,
      "description": "Vaccine Details"
    }
  },
  "required": [
    "resourceType",
    "name",
    "dob",
    "vaccineDetails"
  ],
  "resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVPSD",
  "fhir:parent": "http://smart.who.int/icvp/StructureDefinition/ICVP",
  "jsonld:valuesets": [
    "v2-0203",
    "identifier-type|4.0.1",
    "resource-types|4.0.1",
    "identifier-use|4.0.1"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "v2-0203": "http://smart.who.int/base/ValueSet-v2-0203.jsonld",
    "identifier-type|4.0.1": "http://smart.who.int/base/ValueSet-identifier-type|4.0.1.jsonld",
    "resource-types|4.0.1": "http://smart.who.int/base/ValueSet-resource-types|4.0.1.jsonld",
    "identifier-use|4.0.1": "http://smart.who.int/base/ValueSet-identifier-use|4.0.1.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from ICVP

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* ICVP ICVP
Instances of this logical model can be the target of a Reference
... name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... dob
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... sex
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... nid
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... guardian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... issuer
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... vaccineDetails 1..* ICVPVaccineDetailsSD Vaccine Details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* ICVP ICVP
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... dob 1..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 date Primitive value for date
... sex 0..1 code Sex
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
... nid 0..1 Identifier National Identification Document
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... guardian 0..1 string Parent/Guardian
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... issuer 0..1 Reference(Organization) Document issuer
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... 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
... vaccineDetails 1..* ICVPVaccineDetailsSD Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.nid.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ICVP.nid.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ICVP.ndt Base extensible hl7VS-identifierType 📦2.0.0 THO v6.5
ICVP.issuer.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ICVP

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* ICVP ICVP
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... dob 1..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 date Primitive value for date
... sex 0..1 code Sex
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
... nid 0..1 Identifier National Identification Document
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... guardian 0..1 string Parent/Guardian
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... issuer 0..1 Reference(Organization) Document issuer
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... 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
... vaccineDetails 1..* ICVPVaccineDetailsSD Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.nid.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ICVP.nid.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ICVP.ndt Base extensible hl7VS-identifierType 📦2.0.0 THO v6.5
ICVP.issuer.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from ICVP

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* ICVP ICVP
Instances of this logical model can be the target of a Reference
... name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... dob
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... sex
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... nid
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... guardian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... issuer
.... Slices for extension Content/Rules for all slices
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
... vaccineDetails 1..* ICVPVaccineDetailsSD Vaccine Details

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* ICVP ICVP
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... dob 1..1 date Date of Birth
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 date Primitive value for date
... sex 0..1 code Sex
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for code
... nid 0..1 Identifier National Identification Document
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... guardian 0..1 string Parent/Guardian
.... @id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... @value 0..1 string Primitive value for string
Max Length:1048576
... issuer 0..1 Reference(Organization) Document issuer
.... @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
..... extension:SelectiveDisclosure 0..1 code Extension
URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
.... 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
... vaccineDetails 1..* ICVPVaccineDetailsSD Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.nid.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ICVP.nid.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ICVP.ndt Base extensible hl7VS-identifierType 📦2.0.0 THO v6.5
ICVP.issuer.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ICVP

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel