R4 Ballot #2 (Mixed Normative/Trial use)
TerminologyThis page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for namingsystem
{
"resourceType" : "StructureDefinition",
"id" : "NamingSystem",
"meta" : {
"lastUpdated" : "2018-08-19T21:48:56.559+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Terminology"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "Trial Use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/NamingSystem",
"name" : "NamingSystem",
"status" : "draft",
"date" : "2018-08-19T21:48:56+10:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"fhirVersion" : "3.5.0",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern"
}],
"kind" : "resource",
"abstract" : false,
"type" : "NamingSystem",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "NamingSystem",
"path" : "NamingSystem",
"short" : "System of unique identification",
"definition" : "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a guman readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "nsd-1",
"severity" : "error",
"human" : "Root systems cannot have uuid identifiers",
"expression" : "kind != 'root' or uniqueId.all(type != 'uuid')",
"xpath" : "not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')"
},
{
"key" : "nsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "nsd-2",
"severity" : "error",
"human" : "Can't have more than one preferred identifier for a type",
"expression" : "uniqueId.where(preferred = true).select(type).isDistinct()",
"xpath" : "not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.id",
"path" : "NamingSystem.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.meta",
"path" : "NamingSystem.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.implicitRules",
"path" : "NamingSystem.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "NamingSystem.language",
"path" : "NamingSystem.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "NamingSystem.text",
"path" : "NamingSystem.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "NamingSystem.contained",
"path" : "NamingSystem.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.extension",
"path" : "NamingSystem.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. 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" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.modifierExtension",
"path" : "NamingSystem.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.name",
"path" : "NamingSystem.name",
"short" : "Name for this naming system (computer friendly)",
"definition" : "A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The\"symbolic name\" for an OID would be captured as an extension.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.status",
"path" : "NamingSystem.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this naming system. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of naming systems that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "NamingSystem.kind",
"path" : "NamingSystem.kind",
"short" : "codesystem | identifier | root",
"definition" : "Indicates the purpose for the naming system - what kinds of things does it make unique?",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemType"
}],
"strength" : "required",
"description" : "Identifies the purpose of the naming system.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "NamingSystem.date",
"path" : "NamingSystem.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "NamingSystem.publisher",
"path" : "NamingSystem.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the naming system.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.contact",
"path" : "NamingSystem.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "NamingSystem.responsible",
"path" : "NamingSystem.responsible",
"short" : "Who maintains system namespace?",
"definition" : "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"comment" : "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.responsible",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.type",
"path" : "NamingSystem.type",
"short" : "e.g. driver, provider, patient, bank etc.",
"definition" : "Categorizes a naming system for easier search by grouping related naming systems.",
"comment" : "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"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"
}
},
{
"id" : "NamingSystem.description",
"path" : "NamingSystem.description",
"short" : "Natural language description of the naming system",
"definition" : "A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"comment" : "This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "NamingSystem.useContext",
"path" : "NamingSystem.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "NamingSystem.jurisdiction",
"path" : "NamingSystem.jurisdiction",
"short" : "Intended jurisdiction for naming system (if applicable)",
"definition" : "A legal or geographic region in which the naming system is intended to be used.",
"comment" : "It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "NamingSystem.usage",
"path" : "NamingSystem.usage",
"short" : "How/where is it used",
"definition" : "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.usage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NamingSystem.uniqueId",
"path" : "NamingSystem.uniqueId",
"short" : "Unique identifiers used for system",
"definition" : "Indicates how the system may be identified when referenced in electronic exchange.",
"comment" : "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "NamingSystem.uniqueId",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"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" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.uniqueId.id",
"path" : "NamingSystem.uniqueId.id",
"representation" : ["xmlAttr"],
"short" : "xml:id (or equivalent in JSON)",
"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" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NamingSystem.uniqueId.extension",
"path" : "NamingSystem.uniqueId.extension",
"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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NamingSystem.uniqueId.modifierExtension",
"path" : "NamingSystem.uniqueId.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.uniqueId.type",
"path" : "NamingSystem.uniqueId.type",
"short" : "oid | uuid | uri | other",
"definition" : "Identifies the unique identifier scheme used for this particular identifier.",
"comment" : "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemIdentifierType"
}],
"strength" : "required",
"description" : "Identifies the style of unique identifier used to identify a namespace.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type"
}
},
{
"id" : "NamingSystem.uniqueId.value",
"path" : "NamingSystem.uniqueId.value",
"short" : "The unique identifier",
"definition" : "The string that should be sent over the wire to identify the code system or identifier system.",
"comment" : "If the value is a URI intended for use as FHIR system identifier, the URI should not contain \"\\\" or \"?\" or \",\" since this makes escaping very difficult.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "NamingSystem.uniqueId.preferred",
"path" : "NamingSystem.uniqueId.preferred",
"short" : "Is this the id that should be used for this type",
"definition" : "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.preferred",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If there are multiple ids, and one is labeled \"preferred\", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NamingSystem.uniqueId.comment",
"path" : "NamingSystem.uniqueId.comment",
"short" : "Notes about identifier usage",
"definition" : "Notes about the past or intended usage of this identifier.",
"comment" : "e.g. \"must be used in Germany\" or \"was initially published in error with this value\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NamingSystem.uniqueId.period",
"path" : "NamingSystem.uniqueId.period",
"short" : "When is identifier valid?",
"definition" : "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.",
"comment" : "Within a registry, a given identifier should only be \"active\" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "NamingSystem",
"path" : "NamingSystem",
"short" : "System of unique identification",
"definition" : "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "nsd-1",
"severity" : "error",
"human" : "Root systems cannot have uuid identifiers",
"expression" : "kind != 'root' or uniqueId.all(type != 'uuid')",
"xpath" : "not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')"
},
{
"key" : "nsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "nsd-2",
"severity" : "error",
"human" : "Can't have more than one preferred identifier for a type",
"expression" : "uniqueId.where(preferred = true).select(type).isDistinct()",
"xpath" : "not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))"
}],
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.name",
"path" : "NamingSystem.name",
"short" : "Name for this naming system (computer friendly)",
"definition" : "A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The\"symbolic name\" for an OID would be captured as an extension.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "NamingSystem.status",
"path" : "NamingSystem.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this naming system. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of naming systems that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "NamingSystem.kind",
"path" : "NamingSystem.kind",
"short" : "codesystem | identifier | root",
"definition" : "Indicates the purpose for the naming system - what kinds of things does it make unique?",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemType"
}],
"strength" : "required",
"description" : "Identifies the purpose of the naming system.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "NamingSystem.date",
"path" : "NamingSystem.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "NamingSystem.publisher",
"path" : "NamingSystem.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the naming system.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.contact",
"path" : "NamingSystem.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "NamingSystem.responsible",
"path" : "NamingSystem.responsible",
"short" : "Who maintains system namespace?",
"definition" : "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"comment" : "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.type",
"path" : "NamingSystem.type",
"short" : "e.g. driver, provider, patient, bank etc.",
"definition" : "Categorizes a naming system for easier search by grouping related naming systems.",
"comment" : "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"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"
}
},
{
"id" : "NamingSystem.description",
"path" : "NamingSystem.description",
"short" : "Natural language description of the naming system",
"definition" : "A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"comment" : "This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "NamingSystem.useContext",
"path" : "NamingSystem.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "NamingSystem.jurisdiction",
"path" : "NamingSystem.jurisdiction",
"short" : "Intended jurisdiction for naming system (if applicable)",
"definition" : "A legal or geographic region in which the naming system is intended to be used.",
"comment" : "It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "NamingSystem.usage",
"path" : "NamingSystem.usage",
"short" : "How/where is it used",
"definition" : "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "NamingSystem.uniqueId",
"path" : "NamingSystem.uniqueId",
"short" : "Unique identifiers used for system",
"definition" : "Indicates how the system may be identified when referenced in electronic exchange.",
"comment" : "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "NamingSystem.uniqueId.type",
"path" : "NamingSystem.uniqueId.type",
"short" : "oid | uuid | uri | other",
"definition" : "Identifies the unique identifier scheme used for this particular identifier.",
"comment" : "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemIdentifierType"
}],
"strength" : "required",
"description" : "Identifies the style of unique identifier used to identify a namespace.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type"
}
},
{
"id" : "NamingSystem.uniqueId.value",
"path" : "NamingSystem.uniqueId.value",
"short" : "The unique identifier",
"definition" : "The string that should be sent over the wire to identify the code system or identifier system.",
"comment" : "If the value is a URI intended for use as FHIR system identifier, the URI should not contain \"\\\" or \"?\" or \",\" since this makes escaping very difficult.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "NamingSystem.uniqueId.preferred",
"path" : "NamingSystem.uniqueId.preferred",
"short" : "Is this the id that should be used for this type",
"definition" : "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If there are multiple ids, and one is labeled \"preferred\", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn"
},
{
"id" : "NamingSystem.uniqueId.comment",
"path" : "NamingSystem.uniqueId.comment",
"short" : "Notes about identifier usage",
"definition" : "Notes about the past or intended usage of this identifier.",
"comment" : "e.g. \"must be used in Germany\" or \"was initially published in error with this value\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "NamingSystem.uniqueId.period",
"path" : "NamingSystem.uniqueId.period",
"short" : "When is identifier valid?",
"definition" : "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.",
"comment" : "Within a registry, a given identifier should only be \"active\" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
}]
}
}
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.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot #2 (v3.5.0-14907) generated on Sun, Aug 19, 2018 21:53+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
Ballot Comparison |
|
Propose a change