Release 5 Preview #2

Identifier.profile.json

Modeling and Methodology Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

StructureDefinition for Identifier

{
  "resourceType" : "StructureDefinition",
  "id" : "Identifier",
  "meta" : {
    "lastUpdated" : "2020-07-02T00:59:53.707+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  }],
  "url" : "http://hl7.org/fhir/StructureDefinition/Identifier",
  "version" : "4.4.0",
  "name" : "Identifier",
  "status" : "active",
  "date" : "2020-07-02T00:59:53+00:00",
  "publisher" : "HL7 FHIR Standard",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "Base StructureDefinition for Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
  "purpose" : "Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation.",
  "fhirVersion" : "4.4.0",
  "mapping" : [{
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "servd",
    "uri" : "http://www.omg.org/spec/ServD/1.0/",
    "name" : "ServD"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "type" : "Identifier",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [{
      "id" : "Identifier",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "normative"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
        "valueCode" : "4.0.0"
      }],
      "path" : "Identifier",
      "short" : "An identifier intended for computation",
      "definition" : "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Identifier",
        "min" : 0,
        "max" : "*"
      },
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      },
      {
        "identity" : "v2",
        "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
      },
      {
        "identity" : "rim",
        "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" : "servd",
        "map" : "Identifier"
      }]
    },
    {
      "id" : "Identifier.id",
      "path" : "Identifier.id",
      "representation" : ["xmlAttr"],
      "short" : "Unique id for inter-element referencing",
      "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" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUri" : "string"
        }],
        "code" : "http://hl7.org/fhirpath/System.String"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "Identifier.extension",
      "path" : "Identifier.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. 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.",
      "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"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (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"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "Identifier.use",
      "path" : "Identifier.use",
      "short" : "usual | official | temp | secondary | old (If known)",
      "definition" : "The purpose of this identifier.",
      "comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
      "requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Identifier.use",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "code"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : true,
      "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "IdentifierUse"
        }],
        "strength" : "required",
        "description" : "Identifies the purpose for this identifier, if known .",
        "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.4.0"
      },
      "mapping" : [{
        "identity" : "v2",
        "map" : "N/A"
      },
      {
        "identity" : "rim",
        "map" : "Role.code or implied by context"
      }]
    },
    {
      "id" : "Identifier.type",
      "path" : "Identifier.type",
      "short" : "Description of identifier",
      "definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
      "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.",
      "requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Identifier.type",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "IdentifierType"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
          "valueBoolean" : true
        }],
        "strength" : "extensible",
        "description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
      },
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.5"
      },
      {
        "identity" : "rim",
        "map" : "Role.code or implied by context"
      }]
    },
    {
      "id" : "Identifier.system",
      "path" : "Identifier.system",
      "short" : "The namespace for the identifier value",
      "definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
      "comment" : "Identifier.system is always case sensitive.",
      "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" : 0,
      "max" : "1",
      "base" : {
        "path" : "Identifier.system",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "uri"
      }],
      "example" : [{
        "label" : "General",
        "valueUri" : "http://www.acme.com/identifiers/patient"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.4 / EI-2-4"
      },
      {
        "identity" : "rim",
        "map" : "II.root or Role.id.root"
      },
      {
        "identity" : "servd",
        "map" : "./IdentifierType"
      }]
    },
    {
      "id" : "Identifier.value",
      "path" : "Identifier.value",
      "short" : "The value that is unique",
      "definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
      "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](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.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Identifier.value",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "example" : [{
        "label" : "General",
        "valueString" : "123456"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.1 / EI.1"
      },
      {
        "identity" : "rim",
        "map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
      },
      {
        "identity" : "servd",
        "map" : "./Value"
      }]
    },
    {
      "id" : "Identifier.period",
      "path" : "Identifier.period",
      "short" : "Time period when id is/was valid for use",
      "definition" : "Time period during which identifier is/was valid for use.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Identifier.period",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Period"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.7 + CX.8"
      },
      {
        "identity" : "rim",
        "map" : "Role.effectiveTime or implied by context"
      },
      {
        "identity" : "servd",
        "map" : "./StartDate and ./EndDate"
      }]
    },
    {
      "id" : "Identifier.assigner",
      "path" : "Identifier.assigner",
      "short" : "Organization that issued id (may be just text)",
      "definition" : "Organization that issued/manages the identifier.",
      "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.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Identifier.assigner",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.4 / (CX.4,CX.9,CX.10)"
      },
      {
        "identity" : "rim",
        "map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field.  Also Role.scoper"
      },
      {
        "identity" : "servd",
        "map" : "./IdentifierIssuingAuthority"
      }]
    }]
  },
  "differential" : {
    "element" : [{
      "id" : "Identifier",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "normative"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
        "valueCode" : "4.0.0"
      }],
      "path" : "Identifier",
      "short" : "An identifier intended for computation",
      "definition" : "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
      "min" : 0,
      "max" : "*",
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
      },
      {
        "identity" : "rim",
        "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" : "servd",
        "map" : "Identifier"
      }]
    },
    {
      "id" : "Identifier.use",
      "path" : "Identifier.use",
      "short" : "usual | official | temp | secondary | old (If known)",
      "definition" : "The purpose of this identifier.",
      "comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
      "requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "code"
      }],
      "isModifier" : true,
      "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "IdentifierUse"
        }],
        "strength" : "required",
        "description" : "Identifies the purpose for this identifier, if known .",
        "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.4.0"
      },
      "mapping" : [{
        "identity" : "v2",
        "map" : "N/A"
      },
      {
        "identity" : "rim",
        "map" : "Role.code or implied by context"
      }]
    },
    {
      "id" : "Identifier.type",
      "path" : "Identifier.type",
      "short" : "Description of identifier",
      "definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
      "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.",
      "requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "IdentifierType"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
          "valueBoolean" : true
        }],
        "strength" : "extensible",
        "description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
      },
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.5"
      },
      {
        "identity" : "rim",
        "map" : "Role.code or implied by context"
      }]
    },
    {
      "id" : "Identifier.system",
      "path" : "Identifier.system",
      "short" : "The namespace for the identifier value",
      "definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
      "comment" : "Identifier.system is always case sensitive.",
      "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" : 0,
      "max" : "1",
      "type" : [{
        "code" : "uri"
      }],
      "example" : [{
        "label" : "General",
        "valueUri" : "http://www.acme.com/identifiers/patient"
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.4 / EI-2-4"
      },
      {
        "identity" : "rim",
        "map" : "II.root or Role.id.root"
      },
      {
        "identity" : "servd",
        "map" : "./IdentifierType"
      }]
    },
    {
      "id" : "Identifier.value",
      "path" : "Identifier.value",
      "short" : "The value that is unique",
      "definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
      "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](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.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "example" : [{
        "label" : "General",
        "valueString" : "123456"
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.1 / EI.1"
      },
      {
        "identity" : "rim",
        "map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
      },
      {
        "identity" : "servd",
        "map" : "./Value"
      }]
    },
    {
      "id" : "Identifier.period",
      "path" : "Identifier.period",
      "short" : "Time period when id is/was valid for use",
      "definition" : "Time period during which identifier is/was valid for use.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Period"
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.7 + CX.8"
      },
      {
        "identity" : "rim",
        "map" : "Role.effectiveTime or implied by context"
      },
      {
        "identity" : "servd",
        "map" : "./StartDate and ./EndDate"
      }]
    },
    {
      "id" : "Identifier.assigner",
      "path" : "Identifier.assigner",
      "short" : "Organization that issued id (may be just text)",
      "definition" : "Organization that issued/manages the identifier.",
      "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.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "CX.4 / (CX.4,CX.9,CX.10)"
      },
      {
        "identity" : "rim",
        "map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field.  Also Role.scoper"
      },
      {
        "identity" : "servd",
        "map" : "./IdentifierIssuingAuthority"
      }]
    }]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.