athena-namingsystem-profile
type: StructureDefinition
node role: treeRoot
id:
  v: athena-namingsystem-profile
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition athena-namingsystem-profile Name Flags Card. Type Description & Constraints NamingSystem 0..* NamingSystem System of unique identification id 1..1 id Logical id of this artifact name 1..1 string Name for this naming system (computer friendly) status 1..1 code draft | active | retired | unknown kind 1..1 code codesystem | identifier | root uniqueId 1..* BackboneElement Unique identifiers used for system type 1..1 code oid | uuid | uri | other value 1..1 string The unique identifier preferred 0..1 boolean Is this the id that should be used for this type Documentation for this format
url:
  v: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-namingsystem-profile
version:
  v: 25.0.0
name:
  v: AthenaNamingSystem
status:
  v: active
experimental:
  v: false
date:
  v: 2022-03-01
publisher:
  v: athenahealth
contact:
  telecom:
    system:
      v: url
    value:
      v: http://athenahealth.com
description:
  v: Defines constraints and extensions on the Binary resource as supported by Athena Products.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: workflow
  uri:
    v: http://hl7.org/fhir/workflow
  name:
    v: Workflow Pattern
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: NamingSystem
base definition:
  v: http://hl7.org/fhir/StructureDefinition/NamingSystem
  link: http://hl7.org/fhir/StructureDefinition/NamingSystem
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: NamingSystem
    path:
      v: NamingSystem
    short:
      v: System of unique identification
    definition:
      v: A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: NamingSystem
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: 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:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: nsd-0
      severity:
        v: warning
      human:
        v: Name should be usable as an identifier for the module by machine processing applications such as code generation
      expression:
        v: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
      xpath:
        v: not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
      source:
        v: http://hl7.org/fhir/StructureDefinition/NamingSystem
        link: http://hl7.org/fhir/StructureDefinition/NamingSystem
    constraint:
      key:
        v: nsd-1
      severity:
        v: error
      human:
        v: Root systems cannot have uuid identifiers
      expression:
        v: kind != 'root' or uniqueId.all(type != 'uuid')
      xpath:
        v: not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')
      source:
        v: http://hl7.org/fhir/StructureDefinition/NamingSystem
        link: http://hl7.org/fhir/StructureDefinition/NamingSystem
    constraint:
      key:
        v: nsd-2
      severity:
        v: error
      human:
        v: Can't have more than one preferred identifier for a type
      expression:
        v: uniqueId.where(preferred = true).select(type).isDistinct()

v: true

v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))

v: false

v: false

v: false

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: v2
map:
  v: N/A

identity:
  v: rim
map:
  v: N/A

id:
  v: NamingSystem.id
path:
  v: NamingSystem.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: 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:
  v: 1
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: id
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: NamingSystem.meta
path:
  v: NamingSystem.meta
short:
  v: Metadata about the resource
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: NamingSystem.implicitRules
path:
  v: NamingSystem.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: 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:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: 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
is summary:
  v: true

id:
  v: NamingSystem.language
path:
  v: NamingSystem.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value:
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages

id:
  v: NamingSystem.text
path:
  v: NamingSystem.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: 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:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: NamingSystem.contained
path:
  v: NamingSystem.contained
short:
  v: Contained, inline Resources
definition:
  v: 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:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: NamingSystem.extension
path:
  v: NamingSystem.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: NamingSystem.modifierExtension
path:
  v: NamingSystem.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: 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 and/or the understanding of the containing element's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: NamingSystem.name
path:
  v: NamingSystem.name
short:
  v: Name for this naming system (computer friendly)
definition:
  v: A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
comment:
  v: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.
requirements:
  v: Support human navigation and code generation.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: NamingSystem.name
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
condition:
  v: inv-0
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: NamingSystem.status
path:
  v: NamingSystem.status
short:
  v: draft | active | retired | unknown
definition:
  v: The status of this naming system. Enables tracking the life-cycle of the content.
comment:
  v: Allows filtering of naming systems that are appropriate for use versus not.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: NamingSystem.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: PublicationStatus
  strength:
    v: required
  description:
    v: The lifecycle status of an artifact.
  value set:
    v: http://hl7.org/fhir/ValueSet/publication-status|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: workflow
  map:
    v: Definition.status
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status

id:
  v: NamingSystem.kind
path:
  v: NamingSystem.kind
short:
  v: codesystem | identifier | root
definition:
  v: Indicates the purpose for the naming system - what kinds of things does it make unique?
min:
  v: 1
max:
  v: 1
base:
  path:
    v: NamingSystem.kind
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: NamingSystemType
  strength:
    v: required
  description:
    v: Identifies the purpose of the naming system.
  value set:
    v: http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class

id:
  v: NamingSystem.date
path:
  v: NamingSystem.date
short:
  v: Date last changed
definition:
  v: The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.
comment:
  v: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
alias:
  v: Revision Date
min:
  v: 1
max:
  v: 1
base:
  path:
    v: NamingSystem.date
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Definition.date
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.recorded

id:
  v: NamingSystem.publisher
path:
  v: NamingSystem.publisher
short:
  v: Name of the publisher (organization or individual)
definition:
  v: The name of the organization or individual that published the naming system.
comment:
  v: Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.
requirements:
  v: Helps establish the "authority/credibility" of the naming system. May also allow for contact.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.publisher
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Definition.publisher
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.witness

id:
  v: NamingSystem.contact
path:
  v: NamingSystem.contact
short:
  v: Contact details for the publisher
definition:
  v: Contact details to assist a user in finding and communicating with the publisher.
comment:
  v: May be a web site, an email address, a telephone number, etc.
min:
  v: 0
max:
  v: *
base:
  path:
    v: NamingSystem.contact
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactDetail
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Definition.contact

id:
  v: NamingSystem.responsible
path:
  v: NamingSystem.responsible
short:
  v: Who maintains system namespace?
definition:
  v: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
comment:
  v: This is the primary organization. Responsibility for some aspects of a namespace may be delegated.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.responsible
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.witness

id:
  v: NamingSystem.type
path:
  v: NamingSystem.type
short:
  v: e.g. driver, provider, patient, bank etc.
definition:
  v: Categorizes a naming system for easier search by grouping related naming systems.
comment:
  v: This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: IdentifierType
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-type
    link: http://hl7.org/fhir/ValueSet/identifier-type

id:
  v: NamingSystem.description
path:
  v: NamingSystem.description
short:
  v: Natural language description of the naming system
definition:
  v: A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
comment:
  v: This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.description
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: markdown
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Definition.description

id:
  v: NamingSystem.useContext
path:
  v: NamingSystem.useContext
short:
  v: The context that the content is intended to support
definition:
  v: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.
comment:
  v: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
requirements:
  v: Assist in searching for appropriate content.
min:
  v: 0
max:
  v: *
base:
  path:
    v: NamingSystem.useContext
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: UsageContext
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Definition.useContext

id:
  v: NamingSystem.jurisdiction
path:
  v: NamingSystem.jurisdiction
short:
  v: Intended jurisdiction for naming system (if applicable)
definition:
  v: A legal or geographic region in which the naming system is intended to be used.
comment:
  v: It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.
min:
  v: 0
max:
  v: *
base:
  path:
    v: NamingSystem.jurisdiction
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Jurisdiction
  strength:
    v: extensible
  description:
    v: Countries and regions within which this artifact is targeted for use.
  value set:
    v: http://hl7.org/fhir/ValueSet/jurisdiction
    link: http://hl7.org/fhir/ValueSet/jurisdiction
mapping:
  identity:
    v: workflow
  map:
    v: Definition.jurisdiction

id:
  v: NamingSystem.usage
path:
  v: NamingSystem.usage
short:
  v: How/where is it used
definition:
  v: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.usage
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false

id:
  v: NamingSystem.uniqueId
path:
  v: NamingSystem.uniqueId
short:
  v: Unique identifiers used for system
definition:
  v: Indicates how the system may be identified when referenced in electronic exchange.
comment:
  v: Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.
min:
  v: 1
max:
  v: *
base:
  path:
    v: NamingSystem.uniqueId
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: NamingSystem.uniqueId.id
path:
  v: NamingSystem.uniqueId.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: NamingSystem.uniqueId.extension
path:
  v: NamingSystem.uniqueId.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: NamingSystem.uniqueId.modifierExtension
path:
  v: NamingSystem.uniqueId.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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 and/or the understanding of the containing element's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: NamingSystem.uniqueId.type
path:
  v: NamingSystem.uniqueId.type
short:
  v: oid | uuid | uri | other
definition:
  v: Identifies the unique identifier scheme used for this particular identifier.
comment:
  v: Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: NamingSystem.uniqueId.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: NamingSystemIdentifierType
  strength:
    v: required
  description:
    v: Identifies the style of unique identifier used to identify a namespace.
  value set:
    v: http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1
    link: 4.0
    link: .1

id:
  v: NamingSystem.uniqueId.value
path:
  v: NamingSystem.uniqueId.value
short:
  v: The unique identifier
definition:
  v: The string that should be sent over the wire to identify the code system or identifier system.
comment:
  v: If the value is a URI intended for use as FHIR system identifier, the URI should not contain "" or "?" or "," since this makes escaping very difficult.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: NamingSystem.uniqueId.value
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier

id:
  v: NamingSystem.uniqueId.preferred
path:
  v: NamingSystem.uniqueId.preferred
short:
  v: Is this the id that should be used for this type
definition:
  v: Indicates whether this identifier is the "preferred" identifier of this type.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.uniqueId.preferred
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
meaning when missing:
  v: If there are multiple ids, and one is labeled "preferred", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: NamingSystem.uniqueId.comment
path:
  v: NamingSystem.uniqueId.comment
short:
  v: Notes about identifier usage
definition:
  v: Notes about the past or intended usage of this identifier.
comment:
  v: e.g. "must be used in Germany" or "was initially published in error with this value".
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.uniqueId.comment
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false

id:
  v: NamingSystem.uniqueId.period
path:
  v: NamingSystem.uniqueId.period
short:
  v: When is identifier valid?
definition:
  v: Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
comment:
  v: Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: NamingSystem.uniqueId.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false

element:
  id:
    v: NamingSystem
  path:
    v: NamingSystem
  must support:
    v: false
element:
  id:
    v: NamingSystem.id
  path:
    v: NamingSystem.id
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: id
  must support:
    v: false
element:
  id:
    v: NamingSystem.name
  path:
    v: NamingSystem.name
  comment:
    v: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
  must support:
    v: false
element:
  id:
    v: NamingSystem.status
  path:
    v: NamingSystem.status
  comment:
    v: Allows filtering of naming systems that are appropriate for use versus not.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
  must support:
    v: false
element:
  id:
    v: NamingSystem.kind
  path:
    v: NamingSystem.kind
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
  must support:
    v: false
element:
  id:
    v: NamingSystem.uniqueId
  path:
    v: NamingSystem.uniqueId
  comment:
    v: Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.
  min:
    v: 1
  max:
    v: *
  must support:
    v: false
element:
  id:
    v: NamingSystem.uniqueId.type
  path:
    v: NamingSystem.uniqueId.type
  comment:
    v: Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
  must support:
    v: false
element:
  id:
    v: NamingSystem.uniqueId.value
  path:
    v: NamingSystem.uniqueId.value
  comment:
    v: If the value is a URI intended for use as FHIR system identifier, the URI should not contain "" or "?" or "," since this makes escaping very difficult.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
  must support:
    v: false
element:
  id:
    v: NamingSystem.uniqueId.preferred
  path:
    v: NamingSystem.uniqueId.preferred
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
  must support:
    v: false