HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

NationalProviderIdentifierModel

{
  "resourceType" : "StructureDefinition",
  "id" : "cimi-entity-NationalProviderIdentifier-model",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n  <p><b>BC NationalProviderIdentifier Logical Model</b></p>\n  <p>A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.</p>\n</div>"
  },
  "url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-NationalProviderIdentifier-model",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/breastcancer",
      "value" : "cimi.entity.NationalProviderIdentifier"
    }
  ],
  "version" : "0.2.0",
  "name" : "NationalProviderIdentifierModel",
  "title" : "BC NationalProviderIdentifier Logical Model",
  "status" : "draft",
  "date" : "2018-08-17T00:00:00+00:00",
  "publisher" : "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cic/index.cfm"
        }
      ]
    }
  ],
  "description" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
  "keyword" : [
    {
      "system" : "http://ncimeta.nci.nih.gov",
      "code" : "C1549728"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "cimi-entity-NationalProviderIdentifier-model",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model",
        "path" : "cimi-entity-NationalProviderIdentifier-model",
        "definition" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.value",
        "path" : "cimi-entity-NationalProviderIdentifier-model.value",
        "short" : "String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "definition" : "String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.value",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.purpose",
        "path" : "cimi-entity-NationalProviderIdentifier-model.purpose",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0805701"
          }
        ],
        "short" : "Why the item is used.",
        "definition" : "Why the item is used.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.purpose",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "required",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/identifier-use"
          }
        }
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.type",
        "path" : "cimi-entity-NationalProviderIdentifier-model.type",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0332307"
          }
        ],
        "short" : "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
        "definition" : "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.type",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/identifier-type"
          }
        }
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.codeSystem",
        "path" : "cimi-entity-NationalProviderIdentifier-model.codeSystem",
        "short" : "A formal terminology system.",
        "definition" : "A formal terminology system.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.codeSystem",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod",
        "path" : "cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C2985763"
          }
        ],
        "short" : "The date and time span for which something is active, valid, or in force.",
        "definition" : "The date and time span for which something is active, valid, or in force.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.issuer",
        "path" : "cimi-entity-NationalProviderIdentifier-model.issuer",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1561598"
          }
        ],
        "short" : "An organization who issues a qualification, identifier, or license.",
        "definition" : "An organization who issues a qualification, identifier, or license.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.issuer",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model",
        "path" : "cimi-entity-NationalProviderIdentifier-model",
        "definition" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.value",
        "path" : "cimi-entity-NationalProviderIdentifier-model.value",
        "short" : "String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "definition" : "String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.value",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.purpose",
        "path" : "cimi-entity-NationalProviderIdentifier-model.purpose",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0805701"
          }
        ],
        "short" : "Why the item is used.",
        "definition" : "Why the item is used.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.purpose",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "required",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/identifier-use"
          }
        }
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.type",
        "path" : "cimi-entity-NationalProviderIdentifier-model.type",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0332307"
          }
        ],
        "short" : "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
        "definition" : "The most specific code (lowest level term) describing the kind or sort of thing being represented.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.type",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/identifier-type"
          }
        }
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.codeSystem",
        "path" : "cimi-entity-NationalProviderIdentifier-model.codeSystem",
        "short" : "A formal terminology system.",
        "definition" : "A formal terminology system.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.codeSystem",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod",
        "path" : "cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C2985763"
          }
        ],
        "short" : "The date and time span for which something is active, valid, or in force.",
        "definition" : "The date and time span for which something is active, valid, or in force.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-NationalProviderIdentifier-model.issuer",
        "path" : "cimi-entity-NationalProviderIdentifier-model.issuer",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1561598"
          }
        ],
        "short" : "An organization who issues a qualification, identifier, or license.",
        "definition" : "An organization who issues a qualification, identifier, or license.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-NationalProviderIdentifier-model.issuer",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  }
}