| Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.1.0

Australian Digital Health Agency Medicare Records FHIR Implementation Guide. The current version which supersedes this version is 2.2.0. It is based on FHIR® version 3.0.2. See the Directory of published versions for a list of available versions.

# StructureDefinition-vaccine-serial-number-1.json

Formats: Narrative, XML, JSON, Turtle

Raw json

    {
      "resourceType" : "StructureDefinition",
      "id" : "vaccine-serial-number-1",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/STU3/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-vaccine-serial-number-1-definitions.html#Extension\" title=\"Serial number for the vial of vaccine used in an administration.\">Extension</a><a name=\"Extension\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span>..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/extensibility.html#Extension\">Extension</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Vaccine vial serial number</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-vaccine-serial-number-1-definitions.html#Extension.url\">url</a><a name=\"Extension.url\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/STU3/datatypes.html#uri\">uri</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"color: darkgreen\">&quot;http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1&quot;</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck04.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice_item.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-vaccine-serial-number-1-definitions.html#Extension.value[x]:valueString\" title=\"Slice valueString\">value[x]:valueString</a><a name=\"Extension.value_x_\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Vaccine vial serial number</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/STU3/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "url" : "http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1",
      "version" : "1.0.2",
      "name" : "VaccineSerialNumber",
      "title" : "Vaccine Vial Serial Number",
      "status" : "active",
      "experimental" : false,
      "date" : "2023-04-14T04:15:22+00:00",
      "publisher" : "Australian Digital Health Agency",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "email",
              "value" : "help@digitalhealth.gov.au"
            }
          ]
        }
      ],
      "description" : "This extension applies to the Immunization resource and is used to represent the serial number of the vial of vaccine.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "AU",
              "display" : "Australia"
            }
          ]
        }
      ],
      "copyright" : "Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.",
      "fhirVersion" : "3.0.2",
      "mapping" : [
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        }
      ],
      "kind" : "complex-type",
      "abstract" : false,
      "contextType" : "resource",
      "context" : [
        "Immunization"
      ],
      "type" : "Extension",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
      "derivation" : "constraint",
      "snapshot" : {
        "element" : [
          {
            "id" : "Extension",
            "path" : "Extension",
            "short" : "Vaccine vial serial number",
            "definition" : "Serial number for the vial of vaccine used in an administration.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Extension",
              "min" : 0,
              "max" : "*"
            },
            "condition" : [
              "ele-1"
            ],
            "constraint" : [
              {
                "key" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() | (children().count() > id.count())",
                "xpath" : "@value|f:*|h:div",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "ext-1",
                "severity" : "error",
                "human" : "Must have either extensions or value[x], not both",
                "expression" : "extension.exists() != value.exists()",
                "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
                "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
              }
            ]
          },
          {
            "id" : "Extension.id",
            "path" : "Extension.id",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "xml:id (or equivalent in JSON)",
            "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Element.id",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Extension.extension",
            "path" : "Extension.extension",
            "slicing" : {
              "discriminator" : [
                {
                  "type" : "value",
                  "path" : "url"
                }
              ],
              "description" : "Extensions are always sliced by (at least) url",
              "rules" : "open"
            },
            "short" : "Additional Content defined by implementations",
            "definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
            "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
            "alias" : [
              "extensions",
              "user content"
            ],
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Element.extension",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Extension"
              }
            ],
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "Extension.url",
            "path" : "Extension.url",
            "representation" : [
              "xmlAttr"
            ],
            "short" : "identifies the meaning of the extension",
            "definition" : "Source of the definition for the extension code - a logical name or a URL.",
            "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.url",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "uri"
              }
            ],
            "fixedUri" : "http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1",
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          },
          {
            "id" : "Extension.value[x]:valueString",
            "path" : "Extension.value[x]",
            "sliceName" : "valueString",
            "short" : "Vaccine vial serial number",
            "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Extension.value[x]",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "N/A"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "Extension",
            "path" : "Extension",
            "short" : "Vaccine vial serial number",
            "definition" : "Serial number for the vial of vaccine used in an administration.",
            "max" : "1"
          },
          {
            "id" : "Extension.url",
            "path" : "Extension.url",
            "fixedUri" : "http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/vaccine-serial-number-1"
          },
          {
            "id" : "Extension.value[x]:valueString",
            "path" : "Extension.value[x]",
            "sliceName" : "valueString",
            "short" : "Vaccine vial serial number",
            "min" : 1,
            "type" : [
              {
                "code" : "string"
              }
            ]
          }
        ]
      }
    }