R4 Ballot #1 (Mixed Normative/Trial use)
TerminologyThis page is part of the FHIR Specification (v3.3.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
| (No assigned work group) | Maturity Level: 2 | Informative | Use Context: Any |
StructureDefinition for Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets
{
"resourceType": "StructureDefinition",
"id": "shareablecodesystem",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/shareablecodesystem",
"name": "Shareable CodeSystem",
"status": "draft",
"experimental": false,
"date": "2018-04-03T12:05:46+10:00",
"publisher": "HL7",
"description": "Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets",
"fhirVersion": "3.3.0",
"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"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "CodeSystem",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "CodeSystem",
"path": "CodeSystem",
"short": "Declares the existence of and describes a code system or code system supplement",
"definition": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem",
"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-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"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.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"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"
},
{
"key": "csd-1",
"severity": "error",
"human": "Within a code system definition, all the codes SHALL be unique",
"expression": "(concept.code | descendants().concept.code).isDistinct()",
"xpath": "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)",
"source": "CodeSystem"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.id",
"path": "CodeSystem.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": "CodeSystem.meta",
"path": "CodeSystem.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": "CodeSystem.implicitRules",
"path": "CodeSystem.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": "CodeSystem.language",
"path": "CodeSystem.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",
"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
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "CodeSystem.text",
"path": "CodeSystem.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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "CodeSystem.contained",
"path": "CodeSystem.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.",
"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": "CodeSystem.extension",
"path": "CodeSystem.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": "CodeSystem.modifierExtension",
"path": "CodeSystem.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.",
"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": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.url",
"path": "CodeSystem.url",
"short": "Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)",
"definition": "An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this code system is (or will be) published. This is used in [Coding](datatypes.html#Coding).system.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the code system to be referenced by a single globally unique identifier.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "CodeSystem.identifier",
"path": "CodeSystem.identifier",
"short": "Additional identifier for the code system",
"definition": "A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "CodeSystem.version",
"path": "CodeSystem.version",
"short": "Business version of the code system (Coding.version)",
"definition": "The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.",
"comment": "There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version].",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "CodeSystem.name",
"path": "CodeSystem.name",
"short": "Name for this code system (computer friendly)",
"definition": "A natural language name identifying the code 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.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.title",
"path": "CodeSystem.title",
"short": "Name for this code system (human friendly)",
"definition": "A short, descriptive, user-friendly title for the code system.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "CodeSystem.status",
"path": "CodeSystem.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this code system. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of code systems that are appropriate for use versus not.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"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.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.experimental",
"path": "CodeSystem.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of code systems that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.experimental",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "CodeSystem.date",
"path": "CodeSystem.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the code 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 code 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 code 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": 0,
"max": "1",
"base": {
"path": "CodeSystem.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "CodeSystem.publisher",
"path": "CodeSystem.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the code system.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code 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 code system. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the code system. May also allow for contact.",
"alias": [
"steward"
],
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.publisher",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "CodeSystem.contact",
"path": "CodeSystem.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": "CodeSystem.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "CodeSystem.description",
"path": "CodeSystem.description",
"short": "Natural language description of the code system",
"definition": "A free text natural language description of the code system from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the code 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 code 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).",
"alias": [
"Scope",
"Purpose",
"scope"
],
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.useContext",
"path": "CodeSystem.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 code 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": "CodeSystem.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "CodeSystem.jurisdiction",
"path": "CodeSystem.jurisdiction",
"short": "Intended jurisdiction for code system (if applicable)",
"definition": "A legal or geographic region in which the code system is intended to be used.",
"comment": "It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"base": {
"path": "CodeSystem.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",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "CodeSystem.purpose",
"path": "CodeSystem.purpose",
"short": "Why this code system is defined",
"definition": "Explanation of why this code system is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.purpose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "CodeSystem.copyright",
"path": "CodeSystem.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.",
"comment": "... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the code system and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.copyright",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "CodeSystem.caseSensitive",
"path": "CodeSystem.caseSensitive",
"short": "If code comparison is case sensitive",
"definition": "If code comparison is case sensitive when codes within this system are compared to each other.",
"comment": "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.caseSensitive",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.valueSet",
"path": "CodeSystem.valueSet",
"short": "Canonical URL for value set with entire code system",
"definition": "Canonical URL of value set that contains the entire code system.",
"comment": "The definition of the value set SHALL include all codes from this code system and only codes from this code system, and it SHALL be immutable.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.hierarchyMeaning",
"path": "CodeSystem.hierarchyMeaning",
"short": "grouped-by | is-a | part-of | classified-with",
"definition": "The meaning of the hierarchy of concepts.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.hierarchyMeaning",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CodeSystemHierarchyMeaning"
}
],
"strength": "required",
"description": "The meaning of the hierarchy of concepts in a code system",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning"
}
},
{
"id": "CodeSystem.compositional",
"path": "CodeSystem.compositional",
"short": "If code system defines a post-composition grammar",
"definition": "True If code system defines a post-composition grammar.",
"comment": "Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.",
"alias": [
"grammar"
],
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.compositional",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.versionNeeded",
"path": "CodeSystem.versionNeeded",
"short": "If definitions are not stable",
"definition": "This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.",
"comment": "Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.versionNeeded",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.content",
"path": "CodeSystem.content",
"short": "not-present | example | fragment | complete | supplement",
"definition": "How much of the content of the code system - the concepts and codes it defines - are represented in this resource.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.content",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CodeSystemContentMode"
}
],
"strength": "required",
"description": "How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/codesystem-content-mode"
}
},
{
"id": "CodeSystem.supplements",
"path": "CodeSystem.supplements",
"short": "Code System this adds designations and properties to",
"definition": "References the code system that this code system supplement is adding designations and properties to.",
"comment": "The most common use of a code system supplement is to add additional language support.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.supplements",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/CodeSystem"
]
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.count",
"path": "CodeSystem.count",
"short": "Total concepts in the code system",
"definition": "The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.",
"comment": "The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content value.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.count",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.filter",
"path": "CodeSystem.filter",
"short": "Filter that can be used in a value set",
"definition": "A filter that can be used in a value set compose statement when selecting concepts using a filter.",
"min": 0,
"max": "*",
"base": {
"path": "CodeSystem.filter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.filter.id",
"path": "CodeSystem.filter.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": "CodeSystem.filter.extension",
"path": "CodeSystem.filter.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": "CodeSystem.filter.modifierExtension",
"path": "CodeSystem.filter.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 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.",
"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": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.filter.code",
"path": "CodeSystem.filter.code",
"short": "Code that identifies the filter",
"definition": "The code that identifies this filter when it is used in the instance.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.filter.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.filter.description",
"path": "CodeSystem.filter.description",
"short": "How or why the filter is used",
"definition": "A description of how or why the filter is used.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.filter.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.filter.operator",
"path": "CodeSystem.filter.operator",
"short": "Operators that can be used with filter",
"definition": "A list of operators that can be used with the filter.",
"min": 1,
"max": "*",
"base": {
"path": "CodeSystem.filter.operator",
"min": 1,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FilterOperator"
}
],
"strength": "required",
"description": "The kind of operation to perform as a part of a property based filter.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/filter-operator"
}
},
{
"id": "CodeSystem.filter.value",
"path": "CodeSystem.filter.value",
"short": "What to use for the value",
"definition": "A description of what the value for the filter should be.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.filter.value",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.property",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Property"
}
],
"path": "CodeSystem.property",
"short": "Additional information supplied about each concept",
"definition": "A property defines an additional slot through which additional information can be provided about a concept.",
"min": 0,
"max": "*",
"base": {
"path": "CodeSystem.property",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.property.id",
"path": "CodeSystem.property.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": "CodeSystem.property.extension",
"path": "CodeSystem.property.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": "CodeSystem.property.modifierExtension",
"path": "CodeSystem.property.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 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.",
"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": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.property.code",
"path": "CodeSystem.property.code",
"short": "Identifies the property on the concepts, and when referred to in operations",
"definition": "A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.property.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.property.uri",
"path": "CodeSystem.property.uri",
"short": "Formal identifier for the property",
"definition": "Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.property.uri",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.property.description",
"path": "CodeSystem.property.description",
"short": "Why the property is defined, and/or what it conveys",
"definition": "A description of the property- why it is defined, and how its value might be used.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.property.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "CodeSystem.property.type",
"path": "CodeSystem.property.type",
"short": "code | Coding | string | integer | boolean | dateTime | decimal",
"definition": "The type of the property value. Properties of type \"code\" contain a code defined by the code system (e.g. a reference to another defined concept).",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.property.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PropertyType"
}
],
"strength": "required",
"description": "The type of a property value",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/concept-property-type"
}
},
{
"id": "CodeSystem.concept",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ConceptDefinition"
}
],
"path": "CodeSystem.concept",
"short": "Concepts in the code system",
"definition": "Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.",
"comment": "If this is empty, it means that the code system resource does not represent the content of the code system.",
"min": 1,
"max": "*",
"base": {
"path": "CodeSystem.concept",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.id",
"path": "CodeSystem.concept.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": "CodeSystem.concept.extension",
"path": "CodeSystem.concept.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": "CodeSystem.concept.modifierExtension",
"path": "CodeSystem.concept.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 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.",
"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": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.concept.code",
"path": "CodeSystem.concept.code",
"short": "Code that identifies concept",
"definition": "A code - a text symbol - that uniquely identifies the concept within the code system.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.concept.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.display",
"path": "CodeSystem.concept.display",
"short": "Text to display to the user",
"definition": "A human readable string that is the recommended default way to present this concept to a user.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.concept.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.definition",
"path": "CodeSystem.concept.definition",
"short": "Formal definition",
"definition": "The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.concept.definition",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.designation",
"path": "CodeSystem.concept.designation",
"short": "Additional representations for the concept",
"definition": "Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.",
"requirements": "Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.",
"min": 0,
"max": "*",
"base": {
"path": "CodeSystem.concept.designation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.designation.id",
"path": "CodeSystem.concept.designation.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": "CodeSystem.concept.designation.extension",
"path": "CodeSystem.concept.designation.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": "CodeSystem.concept.designation.modifierExtension",
"path": "CodeSystem.concept.designation.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 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.",
"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": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.concept.designation.language",
"path": "CodeSystem.concept.designation.language",
"short": "Human language of the designation",
"definition": "The language this designation is defined for.",
"comment": "In the absence of a language, the resource language applies.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.concept.designation.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"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
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "CodeSystem.concept.designation.use",
"path": "CodeSystem.concept.designation.use",
"short": "Details how this designation would be used",
"definition": "A code that details how this designation would be used.",
"comment": "If no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min": 0,
"max": "1",
"base": {
"path": "CodeSystem.concept.designation.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptDesignationUse"
}
],
"strength": "extensible",
"description": "Details of how a designation would be used.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id": "CodeSystem.concept.designation.value",
"path": "CodeSystem.concept.designation.value",
"short": "The text value for this designation",
"definition": "The text value for this designation.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.concept.designation.value",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.property",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ConceptProperty"
}
],
"path": "CodeSystem.concept.property",
"short": "Property value for the concept",
"definition": "A property value for this concept.",
"min": 0,
"max": "*",
"base": {
"path": "CodeSystem.concept.property",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.property.id",
"path": "CodeSystem.concept.property.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": "CodeSystem.concept.property.extension",
"path": "CodeSystem.concept.property.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": "CodeSystem.concept.property.modifierExtension",
"path": "CodeSystem.concept.property.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 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.",
"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": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.concept.property.code",
"path": "CodeSystem.concept.property.code",
"short": "Reference to CodeSystem.property.code",
"definition": "A code that is a reference to CodeSystem.property.code.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.concept.property.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.property.value[x]",
"path": "CodeSystem.concept.property.value[x]",
"short": "Value of the property for this concept",
"definition": "The value of this property.",
"min": 1,
"max": "1",
"base": {
"path": "CodeSystem.concept.property.value[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
},
{
"code": "Coding"
},
{
"code": "string"
},
{
"code": "integer"
},
{
"code": "boolean"
},
{
"code": "dateTime"
},
{
"code": "decimal"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "CodeSystem.concept.concept",
"path": "CodeSystem.concept.concept",
"short": "Child Concepts (is-a/contains/categorizes)",
"definition": "Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.",
"min": 0,
"max": "*",
"base": {
"path": "CodeSystem.concept.concept",
"min": 0,
"max": "*"
},
"contentReference": "#CodeSystem.concept",
"isModifier": false,
"isSummary": false
}
]
},
"differential": {
"element": [
{
"id": "CodeSystem",
"path": "CodeSystem",
"min": 1,
"max": "1"
},
{
"id": "CodeSystem.url",
"path": "CodeSystem.url",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "CodeSystem.version",
"path": "CodeSystem.version",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CodeSystem.name",
"path": "CodeSystem.name",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CodeSystem.status",
"path": "CodeSystem.status",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.experimental",
"path": "CodeSystem.experimental",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CodeSystem.publisher",
"path": "CodeSystem.publisher",
"alias": [
"steward"
],
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CodeSystem.description",
"path": "CodeSystem.description",
"alias": [
"scope"
],
"min": 1,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CodeSystem.caseSensitive",
"path": "CodeSystem.caseSensitive",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CodeSystem.concept",
"path": "CodeSystem.concept",
"min": 1,
"max": "*"
},
{
"id": "CodeSystem.concept.code",
"path": "CodeSystem.concept.code",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "CodeSystem.concept.display",
"path": "CodeSystem.concept.display",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CodeSystem.concept.definition",
"path": "CodeSystem.concept.definition",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CodeSystem.concept.concept",
"path": "CodeSystem.concept.concept",
"min": 0,
"max": "*",
"contentReference": "#CodeSystem.concept"
}
]
}
}
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:10+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change