{
"description": "Definition für NamingSystem-Ressourcen in deutschen Profilen",
"_filename": "Profile-namingsystem-de-basis.json",
"package_name": "basisprofil.de",
"date": "2017-09-15",
"derivation": "constraint",
"meta": {
"lastUpdated": "2017-09-09T21:48:06.151+01:00"
},
"publisher": "HL7 Deutschland e.V. (Technisches Komitee FHIR)",
"fhirVersion": "3.0.1",
"purpose": "Definition für NamingSystem-Ressourcen in deutschen Profilen",
"name": "namingsystem-de-basis",
"abstract": false,
"copyright": "HL7 Deutschland e.V.",
"type": "NamingSystem",
"experimental": "true",
"resourceType": "StructureDefinition",
"title": "Namingsystem, deutsches Basisprofil",
"package_version": "0.2.40",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "nsd-1",
"human": "Root systems cannot have uuid identifiers",
"xpath": "not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')",
"severity": "error",
"expression": "kind != 'root' or uniqueId.type = 'uuid'"
}, {
"key": "nsd-3",
"human": "Can only have replacedBy if naming system is retired",
"xpath": "not(f:replacedBy) or f:status/@value='retired'",
"severity": "error",
"expression": "replacedBy.empty() or status = 'retired'"
}, {
"key": "nsd-2",
"human": "Can't have more than one preferred identifier for a type",
"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 ()))",
"severity": "error",
"expression": "uniqueId.where(preferred = true).select(type).isDistinct()"
} ],
"path": "NamingSystem",
"min": 0,
"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.",
"short": "System of unique identification",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "conformance.terminology",
"identity": "w5"
} ],
"max": "*",
"id": "NamingSystem",
"base": {
"max": "*",
"min": 0,
"path": "Resource"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "NamingSystem.id",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "NamingSystem.meta",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "NamingSystem.implicitRules",
"condition": [ "ele-1" ],
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "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
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "NamingSystem.language",
"condition": [ "ele-1" ],
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "NamingSystem.text",
"condition": [ "ele-1", "dom-1" ],
"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 in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "NamingSystem.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "NamingSystem.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "NamingSystem.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"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": "NamingSystem.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": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "NamingSystem.modifierExtension",
"min": 0,
"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. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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": "NamingSystem.modifierExtension",
"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": "DomainResource.modifierExtension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.name",
"requirements": "Support human navigation and code generation.",
"min": 1,
"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.",
"short": "Name for this naming system (computer friendly)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "NamingSystem.name",
"condition": [ "ele-1" ],
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. The\"symbolic name\" for an OID would be captured as an extension.",
"base": {
"max": "1",
"min": 1,
"path": "NamingSystem.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.status",
"min": 1,
"definition": "The status of this naming system. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"max": "1",
"id": "NamingSystem.status",
"condition": [ "ele-1" ],
"comment": "Allows filtering of naming systems that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired naming system without due consideration.",
"base": {
"max": "1",
"min": 1,
"path": "NamingSystem.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.kind",
"min": 1,
"definition": "Indicates the purpose for the naming system - what kinds of things does it make unique?",
"short": "codesystem | identifier | root",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NamingSystemType"
} ],
"description": "Identifies the purpose of the naming system.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/namingsystem-type"
}
},
"max": "1",
"id": "NamingSystem.kind",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 1,
"path": "NamingSystem.kind"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.date",
"min": 1,
"definition": "The date (and optionally time) when the naming system was published. The date must change if and 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.",
"short": "Date this was last changed",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "Revision Date" ],
"max": "1",
"id": "NamingSystem.date",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "1",
"min": 1,
"path": "NamingSystem.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min": 0,
"definition": "The name of the individual or organization that published the naming system.",
"short": "Name of the publisher (organization or individual)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "NamingSystem.publisher",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.publisher"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"short": "Contact details for the publisher",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "NamingSystem.contact",
"condition": [ "ele-1" ],
"comment": "May be a web site, an email address, a telephone number, etc.",
"base": {
"max": "*",
"min": 0,
"path": "NamingSystem.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.responsible",
"min": 0,
"definition": "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"short": "Who maintains system namespace?",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "NamingSystem.responsible",
"condition": [ "ele-1" ],
"comment": "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.responsible"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.type",
"min": 1,
"definition": "Typ (Gruppe) des beschriebenen NamingSystems",
"short": "Typ des beschriebenen NamingSystems",
"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"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://fhir.de/ValueSet/identifier-type-de-basis"
}
},
"max": "1",
"id": "NamingSystem.type",
"condition": [ "ele-1" ],
"comment": "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.type"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.description",
"min": 0,
"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.",
"short": "Natural language description of the naming system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "NamingSystem.description",
"condition": [ "ele-1" ],
"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 profile is presumed to be the predominant language in the place the profile was created).",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.description"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"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.",
"short": "Context the content is intended to support",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "UsageContext"
} ],
"max": "*",
"id": "NamingSystem.useContext",
"condition": [ "ele-1" ],
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "NamingSystem.useContext"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the naming system is intended to be used.",
"short": "Intended jurisdiction for naming system (if applicable)",
"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"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
"max": "*",
"id": "NamingSystem.jurisdiction",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "*",
"min": 0,
"path": "NamingSystem.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.usage",
"min": 0,
"definition": "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"short": "How/where is it used",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "NamingSystem.usage",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.usage"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.uniqueId",
"min": 1,
"definition": "Indicates how the system may be identified when referenced in electronic exchange.",
"short": "Unique identifiers used for system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "NamingSystem.uniqueId",
"condition": [ "ele-1" ],
"comment": "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"base": {
"max": "*",
"min": 1,
"path": "NamingSystem.uniqueId"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.uniqueId.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "NamingSystem.uniqueId.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"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",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "NamingSystem.uniqueId.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"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": "NamingSystem.uniqueId.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",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "NamingSystem.uniqueId.modifierExtension",
"min": 0,
"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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "NamingSystem.uniqueId.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.uniqueId.type",
"min": 1,
"definition": "Identifies the unique identifier scheme used for this particular identifier.",
"short": "oid | uuid | uri | other",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NamingSystemIdentifierType"
} ],
"description": "Identifies the style of unique identifier used to identify a namespace.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type"
}
},
"max": "1",
"id": "NamingSystem.uniqueId.type",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "1",
"min": 1,
"path": "NamingSystem.uniqueId.type"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.uniqueId.value",
"min": 1,
"definition": "The string that should be sent over the wire to identify the code system or identifier system.",
"short": "The unique identifier",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "NamingSystem.uniqueId.value",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "1",
"min": 1,
"path": "NamingSystem.uniqueId.value"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.uniqueId.preferred",
"min": 0,
"definition": "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"short": "Is this the id that should be used for this type",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"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",
"max": "1",
"id": "NamingSystem.uniqueId.preferred",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.uniqueId.preferred"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "NamingSystem.uniqueId.comment",
"min": 0,
"definition": "Notes about the past or intended usage of this identifier.",
"short": "Notes about identifier usage",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "NamingSystem.uniqueId.comment",
"condition": [ "ele-1" ],
"comment": "e.g. \"must be used in Germany\" or \"was initially published in error with this value\".",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.uniqueId.comment"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)",
"severity": "error",
"expression": "start.empty() or end.empty() or (start <= end)"
} ],
"path": "NamingSystem.uniqueId.period",
"min": 0,
"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.",
"short": "When is identifier valid?",
"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"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "NamingSystem.uniqueId.period",
"condition": [ "ele-1" ],
"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).",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.uniqueId.period"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "NamingSystem.replacedBy",
"min": 0,
"definition": "For naming systems that are retired, indicates the naming system that should be used in their place (if any).",
"short": "Use this instead",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
} ],
"max": "1",
"id": "NamingSystem.replacedBy",
"condition": [ "ele-1", "nsd-3" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "NamingSystem.replacedBy"
}
} ]
},
"status": "retired",
"id": "f79771a4-d487-4482-9246-dd154b8a8bc3",
"kind": "resource",
"url": "http://fhir.de/StructureDefinition/namingsystem-de-basis",
"version": "0.1",
"differential": {
"element": [ {
"id": "NamingSystem.type",
"min": 1,
"path": "NamingSystem.type",
"short": "Typ des beschriebenen NamingSystems",
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"valueSetReference": {
"reference": "http://fhir.de/ValueSet/identifier-type-de-basis"
}
},
"definition": "Typ (Gruppe) des beschriebenen NamingSystems",
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.de/technische-komitees/fhir/",
"system": "other"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
}