{
  "description": "This identifier profile defines an Individual Healthcare Identifier (IHI) in an Australian context.",
  "_filename": "StructureDefinition-au-ihi.json",
  "package_name": "hl7.fhir.au.base",
  "date": "2020-10-09",
  "derivation": "constraint",
  "publisher": "Health Level Seven Australia (Patient Administration WG)",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "AU",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "AUIHI",
  "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 IHI",
  "package_version": "2.2.0-ballot",
  "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-ihi-value-0",
        "human": "IHI shall be an exactly 16 digit number",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
        "severity": "error",
        "expression": "value.matches('^([0-9]{16})$')"
      }, {
        "key": "inv-ihi-value-1",
        "human": "IHI prefix is 800360",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
        "severity": "error",
        "expression": "value.startsWith('800360')"
      }, {
        "key": "inv-ihi-value-2",
        "human": "IHI shall pass the Luhn algorithm check",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
        "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": "Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient.",
      "isModifier": false,
      "short": "Individual Healthcare Identifier (IHI)",
      "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": "An Extension",
      "isModifier": false,
      "short": "Extension",
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "max": "*",
      "id": "Identifier.extension",
      "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())"
      }, {
        "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": "IHI number status associated with an IHI identifier.",
      "isModifier": false,
      "short": "IHI status",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org.au/fhir/StructureDefinition/ihi-status" ]
      } ],
      "sliceName": "ihiStatus",
      "max": "1",
      "id": "Identifier.extension:ihiStatus",
      "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())"
      }, {
        "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": "Known IHI record status associated with an IHI identifier.",
      "isModifier": false,
      "short": "IHI record status",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org.au/fhir/StructureDefinition/ihi-record-status" ]
      } ],
      "sliceName": "ihiRecordStatus",
      "max": "1",
      "id": "Identifier.extension:ihiRecordStatus",
      "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())"
      }, {
        "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": "The date that the IHI was verified with HI Services.",
      "isModifier": false,
      "short": "IHI Verification Date",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org.au/fhir/StructureDefinition/ihi-verified" ]
      } ],
      "sliceName": "ihiVerified",
      "max": "1",
      "id": "Identifier.extension:ihiVerified",
      "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": "Description of identifier",
      "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"
        }, {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
          "valueBoolean": true
        } ],
        "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": "NI",
          "system": "http://terminology.hl7.org/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/hi/ihi/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": "IHI",
      "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",
      "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.  The value's primary purpose is computational mapping.  As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.)  A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
      "maxLength": 16,
      "example": [ {
        "label": "General",
        "valueString": "123456"
      }, {
        "label": "IHI",
        "valueString": "8003608833357361"
      } ],
      "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": "edebb71a-d367-4a3b-9766-a74654a98615",
  "kind": "complex-type",
  "url": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
  "version": "2.2.0",
  "differential": {
    "element": [ {
      "id": "Identifier",
      "path": "Identifier",
      "short": "Individual Healthcare Identifier (IHI)",
      "constraint": [ {
        "key": "inv-ihi-value-0",
        "human": "IHI shall be an exactly 16 digit number",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
        "severity": "error",
        "expression": "value.matches('^([0-9]{16})$')"
      }, {
        "key": "inv-ihi-value-1",
        "human": "IHI prefix is 800360",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
        "severity": "error",
        "expression": "value.startsWith('800360')"
      }, {
        "key": "inv-ihi-value-2",
        "human": "IHI shall pass the Luhn algorithm check",
        "source": "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
        "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": "Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient."
    }, {
      "id": "Identifier.extension",
      "path": "Identifier.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "Identifier.extension:ihiStatus",
      "max": "1",
      "path": "Identifier.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org.au/fhir/StructureDefinition/ihi-status" ]
      } ],
      "sliceName": "ihiStatus"
    }, {
      "id": "Identifier.extension:ihiRecordStatus",
      "max": "1",
      "path": "Identifier.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org.au/fhir/StructureDefinition/ihi-record-status" ]
      } ],
      "sliceName": "ihiRecordStatus"
    }, {
      "id": "Identifier.extension:ihiVerified",
      "max": "1",
      "path": "Identifier.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org.au/fhir/StructureDefinition/ihi-verified" ]
      } ],
      "sliceName": "ihiVerified"
    }, {
      "id": "Identifier.type",
      "min": 1,
      "path": "Identifier.type",
      "patternCodeableConcept": {
        "coding": [ {
          "code": "NI",
          "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
        } ]
      }
    }, {
      "id": "Identifier.system",
      "min": 1,
      "path": "Identifier.system",
      "fixedUri": "http://ns.electronichealth.net.au/id/hi/ihi/1.0"
    }, {
      "id": "Identifier.value",
      "min": 1,
      "path": "Identifier.value",
      "short": "IHI",
      "example": [ {
        "label": "IHI",
        "valueString": "8003608833357361"
      } ],
      "maxLength": 16
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "use": "work",
      "value": "http://hl7.com.au",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier"
}