{
  "description": "Person Identifier containing metadata from FREG",
  "_filename": "gd-Identifier-freg.StructureDefinition-profile.json",
  "package_name": "ehelse.fhir.no.grunndata",
  "date": "2019-10-16",
  "derivation": "constraint",
  "publisher": null,
  "fhirVersion": "4.0.0",
  "purpose": "Folkeregisteridentifikator identifikasjonsnummer",
  "name": "GdIdentifierFreg",
  "abstract": false,
  "type": "Identifier",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": null,
  "package_version": "2.1.0",
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier",
      "min": 0,
      "definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
      "short": "An identifier intended for computation",
      "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.",
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "_code": {
          "extension": [ {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
            "valueString": "string"
          }, {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
            "valueString": "xsd:string"
          }, {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
            "valueString": "xsd:string"
          } ]
        }
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Identifier.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      }
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "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": "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.",
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "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",
      "condition": [ "ele-1" ],
      "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"
      }
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "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": "Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Identifier.extension",
      "min": 0,
      "definition": "Registermetadata describes metadata about resources available from the norwegian person index (folkeregisteret), all resources containing metadata from folkeregisteret will include registermetadata",
      "short": "registermetadata fra folkeregisteret",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "Extension",
        "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-fregmetadata" ]
      } ],
      "mustSupport": true,
      "sliceName": "fregMetadata",
      "alias": [ "extensions", "user content", "registermetadata", "RegistermetadataMedGyldighet" ],
      "max": "1",
      "id": "Identifier.extension:fregMetadata",
      "condition": [ "ele-1" ],
      "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"
      }
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "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": "Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Identifier.extension",
      "min": 0,
      "definition": "The status of a person identifier from FREG",
      "short": "The status of a person identifier from FREG",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "Extension",
        "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-person-identifier-status" ]
      } ],
      "mustSupport": true,
      "sliceName": "fregStatus",
      "alias": [ "extensions", "user content", "Identifikatorstatuskode", "status" ],
      "max": "1",
      "id": "Identifier.extension:fregStatus",
      "condition": [ "ele-1" ],
      "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"
      }
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "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": "All Person identifiers from FREG will be of use \"official\". This element is not used by gd-Identifier.",
      "isModifier": true,
      "short": "usual | official | temp | secondary | old (If known)",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "N/A",
        "identity": "v2"
      }, {
        "map": "Role.code or implied by context",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "code"
      } ],
      "mustSupport": false,
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.0",
        "description": "Identifies the purpose for this identifier, if known ."
      },
      "max": "1",
      "id": "Identifier.use",
      "condition": [ "ele-1" ],
      "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": "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": 0,
      "definition": "gd-Idenfitier don't use this element",
      "short": "Description of identifier",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "CE/CNE/CWE",
        "identity": "v2"
      }, {
        "map": "CD",
        "identity": "rim"
      }, {
        "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
        "identity": "orim"
      }, {
        "map": "CX.5",
        "identity": "v2"
      }, {
        "map": "Role.code or implied by context",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "mustSupport": false,
      "binding": {
        "strength": "extensible",
        "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
        "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",
      "condition": [ "ele-1" ],
      "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.",
      "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": "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": 0,
      "definition": "gd-Identifier can be either Fødselsnummer or D-nummer",
      "short": "The namespace for the identifier value",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "CX.4 / EI-2-4",
        "identity": "v2"
      }, {
        "map": "II.root or Role.id.root",
        "identity": "rim"
      }, {
        "map": "./IdentifierType",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "uri"
      } ],
      "mustSupport": true,
      "max": "1",
      "id": "Identifier.system",
      "condition": [ "ele-1" ],
      "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": "Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Identifier.value",
      "min": 0,
      "definition": "The identifier value from FREG",
      "short": "The identifier value from FREG",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "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"
      } ],
      "mustSupport": true,
      "max": "1",
      "id": "Identifier.value",
      "condition": [ "ele-1" ],
      "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.",
      "example": [ {
        "label": "General",
        "valueString": "123456"
      } ],
      "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": "Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "per-1",
        "human": "If present, start SHALL have a lower value than end",
        "xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
        "source": "Period",
        "severity": "error",
        "expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)"
      } ],
      "path": "Identifier.period",
      "min": 0,
      "definition": "gd-Idenfitier don't use this element\r\n\r\nTime period during which identifier is/was valid for use.",
      "short": "Time period when id is/was valid for use",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "DR",
        "identity": "v2"
      }, {
        "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
        "identity": "rim"
      }, {
        "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"
      } ],
      "mustSupport": false,
      "max": "1",
      "id": "Identifier.period",
      "condition": [ "ele-1" ],
      "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
      "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": "Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ref-1",
        "human": "SHALL have a contained resource if a local reference is provided",
        "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
        "source": "Reference",
        "severity": "error",
        "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
      } ],
      "path": "Identifier.assigner",
      "min": 0,
      "definition": "gd-Idenfitier don't use this element\r\n\r\nOrganization that issued/manages the identifier.",
      "short": "Organization that issued id (may be just text)",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
        "identity": "rim"
      }, {
        "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" ]
      } ],
      "mustSupport": false,
      "max": "1",
      "id": "Identifier.assigner",
      "condition": [ "ele-1" ],
      "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": "5f252174-c0cb-4940-8343-52590168c927",
  "kind": "complex-type",
  "url": "http://ehelse.no/fhir/StructureDefinition/gd-Identifier-freg",
  "version": "2.0.2",
  "differential": {
    "element": [ {
      "id": "Identifier.extension",
      "path": "Identifier.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "Identifier.extension:fregMetadata",
      "max": "1",
      "path": "Identifier.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-fregmetadata" ]
      } ],
      "sliceName": "fregMetadata",
      "mustSupport": true
    }, {
      "id": "Identifier.extension:fregStatus",
      "path": "Identifier.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-person-identifier-status" ]
      } ],
      "sliceName": "fregStatus",
      "mustSupport": true
    }, {
      "id": "Identifier.use",
      "path": "Identifier.use",
      "definition": "All Person identifiers from FREG will be of use \"official\". This element is not used by gd-Identifier.",
      "mustSupport": false
    }, {
      "id": "Identifier.type",
      "path": "Identifier.type",
      "definition": "gd-Idenfitier don't use this element",
      "mustSupport": false
    }, {
      "id": "Identifier.system",
      "path": "Identifier.system",
      "definition": "gd-Identifier can be either Fødselsnummer or D-nummer",
      "mustSupport": true
    }, {
      "id": "Identifier.value",
      "path": "Identifier.value",
      "short": "The identifier value from FREG",
      "definition": "The identifier value from FREG",
      "mustSupport": true
    }, {
      "id": "Identifier.period",
      "path": "Identifier.period",
      "definition": "gd-Idenfitier don't use this element\r\n\r\nTime period during which identifier is/was valid for use.",
      "mustSupport": false
    }, {
      "id": "Identifier.assigner",
      "path": "Identifier.assigner",
      "definition": "gd-Idenfitier don't use this element\r\n\r\nOrganization that issued/manages the identifier.",
      "mustSupport": false
    } ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier"
}