| eRS-Specialty-CodeSystem-1 (CodeSystem) | C | | CodeSystem | There are no (further) constraints on this element Element idCodeSystem Short descriptionA set of codes drawn from one or more code systems DefinitionA code system resource specifies a set of codes drawn from one or more code systems.
Data typeCodeSystem Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty() - csd-1: Within a code system definition, all the codes SHALL be unique
(concept.code | descendants().concept.code).isDistinct() Mappings- rim: Entity. Role, or Act
- rim: N/A
- w5: conformance.terminology
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCodeSystem.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCodeSystem.meta Short descriptionMetadata about the resource DefinitionThe 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.
Data typeMeta ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCodeSystem.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
CommentsAsserting 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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingA human language. Common Languages (extensible) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idCodeSystem.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
CommentsContained 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.
Data typeNarrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idCodeSystem.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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.
Data typeResource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idCodeSystem.url Short descriptionLogical URI to reference this code system (globally unique) (Coding.system) DefinitionAn absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see Technical and Business Versions. This is used in [Coding]{datatypes.html#Coding}.system.
RequirementsAllows the code system to be referenced by a single globally unique identifier.
CommentsCan 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.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idCodeSystem.identifier Short descriptionAdditional identifier for the code system DefinitionA 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.
RequirementsAllows externally provided and/or usable business identifiers to be easily associated with the module.
CommentsTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this code system outside of FHIR, where it is not possible to use the logical URI.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- objimpl: no-gen-base
- w5: id
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCodeSystem.version Short descriptionBusiness version of the code system (Coding.version) DefinitionThe 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.
CommentsThere 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 refrence to a particular business version of the code system with the format [url]|[version].
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| name | Σ | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.name Short descriptionName for this code system (computer friendly) DefinitionA 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.
RequirementsSupport human navigation and code generation.
CommentsThe 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.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| title | Σ | 0..0 | string | There are no (further) constraints on this element Element idCodeSystem.title Short descriptionName for this code system (human friendly) DefinitionA short, descriptive, user-friendly title for the code system.
CommentsThis name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.status Short descriptiondraft | active | retired | unknown DefinitionThe status of this code system. Enables tracking the life-cycle of the content.
CommentsAllows filtering of code systems that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired code system without due consideration.
Data typecode BindingThe lifecycle status of a Value Set or Concept Map. PublicationStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| experimental | Σ ?! | 0..0 | boolean | There are no (further) constraints on this element Element idCodeSystem.experimental Short descriptionFor testing purposes, not real usage DefinitionA 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.
RequirementsEnables experimental content to be developed following the same lifecycle that would be used for a production-level code system.
CommentsAllows filtering of code system that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental code system in production.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| date | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idCodeSystem.date Short descriptionDate this was last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the code 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 code system changes.
CommentsNote 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.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- w5: when.recorded
|
| publisher | Σ | 0..0 | string | There are no (further) constraints on this element Element idCodeSystem.publisher Short descriptionName of the publisher (organization or individual) DefinitionThe name of the individual or organization that published the code system.
RequirementsHelps establish the "authority/credibility" of the code system. May also allow for contact.
CommentsUsually 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.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| contact | Σ | 0..0 | ContactDetail | There are no (further) constraints on this element Element idCodeSystem.contact Short descriptionContact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher.
CommentsMay be a web site, an email address, a telephone number, etc.
Data typeContactDetail ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| description | | 0..1 | markdown | There are no (further) constraints on this element Element idCodeSystem.description Short descriptionNatural language description of the code system Alternate namesScope, Purpose DefinitionA free text natural language description of the code system from a consumer's perspective.
CommentsThis 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).
Data typemarkdown ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| useContext | Σ | 0..0 | UsageContext | There are no (further) constraints on this element Element idCodeSystem.useContext Short descriptionContext the content is intended to support DefinitionThe 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.
RequirementsAssist in searching for appropriate content.
CommentsWhen multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Data typeUsageContext ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| jurisdiction | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCodeSystem.jurisdiction Short descriptionIntended jurisdiction for code system (if applicable) DefinitionA legal or geographic region in which the code system is intended to be used.
CommentsIt may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.
Data typeCodeableConcept BindingCountries and regions within which this artifact is targeted for use Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| purpose | | 0..0 | markdown | There are no (further) constraints on this element Element idCodeSystem.purpose Short descriptionWhy this code system is defined DefinitionExplaination of why this code system is needed and why it has been designed as it has.
CommentsThis 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.
Data typemarkdown ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- objimpl: no-gen-base
- w5: why
|
| copyright | | 0..0 | markdown | There are no (further) constraints on this element Element idCodeSystem.copyright Short descriptionUse and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA 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.
RequirementsConsumers must be able to determine any legal restrictions on the use of the code system and/or its content.
CommentsSystems are not required to have markdown support, and there is considerable variation in markdown syntax, so the text should be readable without markdown processing. The preferred markdown syntax is described here: http://daringfireball.net/projects/markdown/syntax (and tests here: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip)
Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.
Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.
Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.
Data typemarkdown ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- objimpl: no-gen-base
|
| caseSensitive | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCodeSystem.caseSensitive Short descriptionIf code comparison is case sensitive DefinitionIf code comparison is case sensitive when codes within this system are compared to each other.
CommentsIf 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.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| valueSet | Σ | 0..1 | uri | There are no (further) constraints on this element Element idCodeSystem.valueSet Short descriptionCanonical URL for value set with entire code system DefinitionCanonical URL of value set that contains the entire code system.
CommentsThe definition of the value set SHALL include all codes from this code system, and it SHALL be immutable.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| hierarchyMeaning | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.hierarchyMeaning Short descriptiongrouped-by | is-a | part-of | classified-with DefinitionThe meaning of the hierarchy of concepts.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typecode BindingThe meaning of the hierarchy of concepts in a code system CodeSystemHierarchyMeaning (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| compositional | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCodeSystem.compositional Short descriptionIf code system defines a post-composition grammar Alternate namesgrammar DefinitionTrue If code system defines a post-composition grammar.
CommentsNote that the code system resource does not define what the compositional grammar is, only whether or not there is one.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| versionNeeded | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCodeSystem.versionNeeded Short descriptionIf definitions are not stable DefinitionThis 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.
CommentsBest 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'.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| content | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.content Short descriptionnot-present | example | fragment | complete DefinitionHow much of the content of the code system - the concepts and codes it defines - are represented in this resource.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typecode BindingHow much of the content of the code system - the concepts and codes it defines - are represented in a code system resource CodeSystemContentMode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| count | Σ | 0..0 | unsignedInt | There are no (further) constraints on this element Element idCodeSystem.count Short descriptionTotal concepts in the code system DefinitionThe 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.
CommentsThe count of concepts defined in this resource cannot be more than this value, but may be less for several reasons - see the content value.
Data typeunsignedInt ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| filter | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.filter Short descriptionFilter that can be used in a value set DefinitionA filter that can be used in a value set compose statement when selecting concepts using a filter.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| property | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.property Short descriptionAdditional information supplied about each concept DefinitionA property defines an additional slot through which additional information can be provided about a concept.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| concept | | 0..* | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.concept Short descriptionConcepts in the code system DefinitionConcepts 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.
CommentsIf this is empty, it means that the code system resource does not represent the content of the code system.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| effectiveToDate | C | 0..1 | Extension(date) | There are no (further) constraints on this element Element idCodeSystem.concept.extension:effectiveToDate Short descriptionThe value set concept effective to date. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
CommentsThere 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.
Data typeExtension(date) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-EffectivetoDate-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| effectiveFromDate | C | 0..1 | Extension(date) | There are no (further) constraints on this element Element idCodeSystem.concept.extension:effectiveFromDate Short descriptionThe value set concept effective from date. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
CommentsThere 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.
Data typeExtension(date) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-EffectivefromDate-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| code | | 1..1 | code | There are no (further) constraints on this element Element idCodeSystem.concept.code Short descriptionCode that identifies concept DefinitionA code - a text symbol - that uniquely identifies the concept within the code system.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typecode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| display | | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.display Short descriptionText to display to the user DefinitionA human readable string that is the recommended default way to present this concept to a user.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| definition | | 0..0 | string | There are no (further) constraints on this element Element idCodeSystem.concept.definition Short descriptionFormal definition DefinitionThe 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.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| designation | | 1..1 | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.concept.designation Short descriptionAdditional representations for the concept DefinitionAdditional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
RequirementsMany concept definition systems support multiple representations, in multiple languages, and for multiple purposes.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.designation.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.designation.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.designation.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| language | | 0..0 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.concept.designation.language Short descriptionHuman language of the designation DefinitionThe language this designation is defined for.
CommentsIn the absence of a language, the resource language applies.
Data typecode BindingA human language. Common Languages (extensible) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| use | | 0..0 | CodingBinding | There are no (further) constraints on this element Element idCodeSystem.concept.designation.use Short descriptionDetails how this designation would be used DefinitionA code that details how this designation would be used.
CommentsIf no use is provided, the designation can be assumed to be suitable for general display to a human user.
Data typeCoding BindingDetails of how a designation would be used. Designation Use (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| value | | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.designation.value Short descriptionThe text value for this designation DefinitionThe text value for this designation.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| property | | 0..0 | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.concept.property Short descriptionProperty value for the concept DefinitionA property value for this concept.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| concept | | 0..* | see (concept) | There are no (further) constraints on this element Element idCodeSystem.concept.concept Short descriptionChild Concepts (is-a/contains/categorizes) DefinitionDefines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.
|