{
  "description": "This identifier profile defines a My Health Record Assigned Identity - Device (PAI-D) identifier in an Australian context. A PAI-D is typically used to identify a device that plays a role, for example an authoring or observing, in the exchange of digital health data with the My Health Record system.",
  "_filename": "StructureDefinition-au-paididentifier.json",
  "package_name": "hl7.fhir.au.base",
  "date": "2024-03-09T23:12:00+11:00",
  "derivation": "constraint",
  "publisher": "HL7 Australia",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "AU",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "AUPAIDIdentifier",
  "mapping": [ {
    "uri": "http://hl7.org/v2",
    "name": "HL7 v2 Mapping",
    "identity": "v2"
  }, {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  }, {
    "uri": "http://www.omg.org/spec/ServD/1.0/",
    "name": "ServD",
    "identity": "servd"
  } ],
  "abstract": false,
  "copyright": "HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.",
  "type": "Identifier",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "AU PAI-D Identifier",
  "package_version": "4.2.0-preview",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 0
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "inv-paid-0",
        "human": "PAI-D shall be 16 digits",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
        "severity": "error",
        "expression": "value.matches('^([0-9]{16})$')"
      }, {
        "key": "inv-paid-1",
        "human": "PAI-D prefix shall be 800364",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
        "severity": "error",
        "expression": "value.startsWith('800364')"
      }, {
        "key": "inv-paid-2",
        "human": "PAI-D shall pass the Luhn algorithm",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
        "severity": "error",
        "expression": "(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)"
      } ],
      "path": "Identifier",
      "min": 0,
      "definition": "My Health Record Assigned Identity - Device (PAI-D) identifier assigned to an organisation.",
      "isModifier": false,
      "short": "My Health Record Assigned Identity - Device (PAI-D) Identifier",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
        "identity": "v2"
      }, {
        "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]",
        "identity": "rim"
      }, {
        "map": "Identifier",
        "identity": "servd"
      } ],
      "max": "*",
      "id": "Identifier",
      "condition": [ "ele-1" ],
      "base": {
        "max": "*",
        "min": 0,
        "path": "Identifier"
      }
    }, {
      "path": "Identifier.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Identifier.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Identifier.extension",
      "min": 0,
      "definition": "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.",
      "isModifier": false,
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "Identifier.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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.use",
      "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
      "min": 0,
      "definition": "The purpose of this identifier.",
      "isModifier": true,
      "short": "usual | official | temp | secondary | old (If known)",
      "mapping": [ {
        "map": "N/A",
        "identity": "v2"
      }, {
        "map": "Role.code or implied by context",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString": "IdentifierUse"
        } ],
        "description": "Identifies the purpose for this identifier, if known ."
      },
      "max": "1",
      "id": "Identifier.use",
      "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Identifier.use"
      },
      "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.type",
      "requirements": "Allows users to make use of identifiers when the identifier system is not known.",
      "min": 1,
      "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
      "isModifier": false,
      "short": "Coded identifier type for PAI-D",
      "mapping": [ {
        "map": "CX.5",
        "identity": "v2"
      }, {
        "map": "Role.code or implied by context",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "extensible",
        "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString": "IdentifierType"
        } ],
        "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
      },
      "max": "1",
      "id": "Identifier.type",
      "comment": "This element deals only with general categories of identifiers.  It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.   Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
      "patternCodeableConcept": {
        "coding": [ {
          "code": "NDI",
          "system": "http://terminology.hl7.org.au/CodeSystem/v2-0203"
        } ]
      },
      "base": {
        "max": "1",
        "min": 0,
        "path": "Identifier.type"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.system",
      "requirements": "There are many sets  of identifiers.  To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
      "min": 1,
      "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
      "isModifier": false,
      "short": "The namespace for the identifier value",
      "fixedUri": "http://ns.electronichealth.net.au/id/pcehr/paid/1.0",
      "mapping": [ {
        "map": "CX.4 / EI-2-4",
        "identity": "v2"
      }, {
        "map": "II.root or Role.id.root",
        "identity": "rim"
      }, {
        "map": "./IdentifierType",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "uri"
      } ],
      "max": "1",
      "id": "Identifier.system",
      "comment": "Identifier.system is always case sensitive.",
      "example": [ {
        "label": "General",
        "valueUri": "http://www.acme.com/identifiers/patient"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Identifier.system"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.value",
      "min": 1,
      "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
      "isModifier": false,
      "short": "PAI-D",
      "mapping": [ {
        "map": "CX.1 / EI.1",
        "identity": "v2"
      }, {
        "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
        "identity": "rim"
      }, {
        "map": "./Value",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "Identifier.value",
      "condition": [ "inv-paid-0", "inv-paid-1", "inv-paid-2" ],
      "comment": "PAI-D values may be test values or production (real) values. A production PAI-D is in the format 8003640003xxxxxz, a test PAI-D is in the format 8003640013xxxxxz.",
      "maxLength": 16,
      "example": [ {
        "label": "General",
        "valueString": "123456"
      }, {
        "label": "PAI-D",
        "valueString": "8003640013000057"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Identifier.value"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.period",
      "min": 0,
      "definition": "Time period during which identifier is/was valid for use.",
      "isModifier": false,
      "short": "Time period when id is/was valid for use",
      "mapping": [ {
        "map": "CX.7 + CX.8",
        "identity": "v2"
      }, {
        "map": "Role.effectiveTime or implied by context",
        "identity": "rim"
      }, {
        "map": "./StartDate and ./EndDate",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "Period"
      } ],
      "max": "1",
      "id": "Identifier.period",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Identifier.period"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.assigner",
      "min": 0,
      "definition": "Organization that issued/manages the identifier.",
      "isModifier": false,
      "short": "Organization that issued id (may be just text)",
      "mapping": [ {
        "map": "CX.4 / (CX.4,CX.9,CX.10)",
        "identity": "v2"
      }, {
        "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field.  Also Role.scoper",
        "identity": "rim"
      }, {
        "map": "./IdentifierIssuingAuthority",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
      } ],
      "max": "1",
      "id": "Identifier.assigner",
      "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Identifier.assigner"
      },
      "isSummary": true
    } ]
  },
  "status": "draft",
  "id": "53c562a7-0d96-46b1-b086-7c952c25d981",
  "kind": "complex-type",
  "url": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
  "version": "4.2.0-preview",
  "differential": {
    "element": [ {
      "id": "Identifier",
      "path": "Identifier",
      "short": "My Health Record Assigned Identity - Device (PAI-D) Identifier",
      "constraint": [ {
        "key": "inv-paid-0",
        "human": "PAI-D shall be 16 digits",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
        "severity": "error",
        "expression": "value.matches('^([0-9]{16})$')"
      }, {
        "key": "inv-paid-1",
        "human": "PAI-D prefix shall be 800364",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
        "severity": "error",
        "expression": "value.startsWith('800364')"
      }, {
        "key": "inv-paid-2",
        "human": "PAI-D shall pass the Luhn algorithm",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-paididentifier",
        "severity": "error",
        "expression": "(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)"
      } ],
      "definition": "My Health Record Assigned Identity - Device (PAI-D) identifier assigned to an organisation."
    }, {
      "id": "Identifier.type",
      "min": 1,
      "path": "Identifier.type",
      "short": "Coded identifier type for PAI-D",
      "patternCodeableConcept": {
        "coding": [ {
          "code": "NDI",
          "system": "http://terminology.hl7.org.au/CodeSystem/v2-0203"
        } ]
      }
    }, {
      "id": "Identifier.system",
      "min": 1,
      "path": "Identifier.system",
      "fixedUri": "http://ns.electronichealth.net.au/id/pcehr/paid/1.0"
    }, {
      "id": "Identifier.value",
      "min": 1,
      "path": "Identifier.value",
      "short": "PAI-D",
      "comment": "PAI-D values may be test values or production (real) values. A production PAI-D is in the format 8003640003xxxxxz, a test PAI-D is in the format 8003640013xxxxxz.",
      "example": [ {
        "label": "PAI-D",
        "valueString": "8003640013000057"
      } ],
      "condition": [ "inv-paid-0", "inv-paid-1", "inv-paid-2" ],
      "maxLength": 16
    } ]
  },
  "contact": [ {
    "name": "HL7 Australia FHIR Working Group",
    "telecom": [ {
      "use": "work",
      "value": "https://confluence.hl7.org/display/HAFWG",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier"
}