Resource Profile: Organization

Introduction

Overview

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ C1..1stringBinding
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ C1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
activeΣ ?!0..1boolean
typeΣ0..*CodeableConcept
nameΣ C0..1string
alias0..*string
descriptionΣ0..1markdown
contactC0..*ExtendedContactDetail
partOfΣ C0..1Reference(Organization)
endpointC0..*Reference(Endpoint)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierC0..*Identifier
code1..1CodeableConcept
periodC0..1Period
issuerC0..1Reference(Organization)
OrganizationC
ShortA grouping of people or organizations with a common purpose
Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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 or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
    (identifier.count() + name.count()) > 0
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: Entity, Role, or Act
  • w5: administrative.group
  • v2: (also see master files messages)
  • rim: Organization(classCode=ORG, determinerCode=INST)
  • interface: ParticipantContactable
  • servd: Organization
Organization.idΣ
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Organization.metaΣ
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Organization.implicitRulesΣ ?!
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

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 its narrative along with other profiles, value sets, etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Organization.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
Comments

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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Organization.textC
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have a 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.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Organization.containedC
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

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.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: N/A
Organization.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content
Requirements

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.

Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.identifierS Σ C
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality1..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

Slicing

Unordered, Open, by system(Value)

Slice on identifier based on system value

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Organization.identifier:organizationIdentifierS Σ C
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Organization.identifier:organizationIdentifier.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Organization.identifier:organizationIdentifier.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.identifier:organizationIdentifier.useΣ ?!
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Organization.identifier:organizationIdentifier.typeΣ
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Organization.identifier:organizationIdentifier.systemS Σ
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
urn:oid:2.5.4.97
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Organization.identifier:organizationIdentifier.valueS Σ C
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ndi-organization-identifier-value-1: A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057
    value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Organization.identifier:organizationIdentifier.periodΣ C
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Organization.identifier:organizationIdentifier.assignerΣ C
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Organization.identifier:hvoOrganizationalUnitIdS Σ C
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Organization.identifier:hvoOrganizationalUnitId.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Organization.identifier:hvoOrganizationalUnitId.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.identifier:hvoOrganizationalUnitId.useΣ ?!
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Organization.identifier:hvoOrganizationalUnitId.typeΣ
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Organization.identifier:hvoOrganizationalUnitId.systemS Σ
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
http://electronichealth.se/identifier/HVO/organization
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Organization.identifier:hvoOrganizationalUnitId.valueS Σ C
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Organization.identifier:hvoOrganizationalUnitId.periodΣ C
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Organization.identifier:hvoOrganizationalUnitId.assignerΣ C
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Organization.identifier:countryCodeS Σ C
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Organization.identifier:countryCode.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Organization.identifier:countryCode.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.identifier:countryCode.useΣ ?!
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Organization.identifier:countryCode.typeΣ
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Organization.identifier:countryCode.systemS Σ
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
urn:iso:std:iso:3166
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Organization.identifier:countryCode.valueS Σ C
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Binding

http://terminology.hl7.org/ValueSet/v3-Country2 (required)

Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Organization.identifier:countryCode.periodΣ C
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Organization.identifier:countryCode.assignerΣ C
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Organization.identifier:personalIdentityNumberS Σ C
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Organization.identifier:personalIdentityNumber.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Organization.identifier:personalIdentityNumber.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.identifier:personalIdentityNumber.useΣ ?!
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Organization.identifier:personalIdentityNumber.typeΣ
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Organization.identifier:personalIdentityNumber.systemS Σ
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
http://electronichealth.se/identifier/personnummer
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Organization.identifier:personalIdentityNumber.valueS Σ C
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
    value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Organization.identifier:personalIdentityNumber.periodΣ C
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Organization.identifier:personalIdentityNumber.assignerΣ C
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Organization.identifier:coordinationNumberS Σ C
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Organization.identifier:coordinationNumber.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Organization.identifier:coordinationNumber.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.identifier:coordinationNumber.useΣ ?!
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Organization.identifier:coordinationNumber.typeΣ
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
Organization.identifier:coordinationNumber.systemS Σ
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
http://electronichealth.se/identifier/samordningsnummer
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Organization.identifier:coordinationNumber.valueS Σ C
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ident-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
    value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Organization.identifier:coordinationNumber.periodΣ C
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Organization.identifier:coordinationNumber.assignerΣ C
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Organization.activeΣ ?!
ShortWhether the organization's record is still in active use
Definition

Whether the organization's record is still in active use.

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • v2: No equivalent in HL7 V2
  • rim: .status
  • interface: Participant.active
  • servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
Organization.typeΣ
ShortKind of organization
Definition

The kind(s) of organization that this is.

Cardinality0..*
TypeCodeableConcept
Binding

Used to categorize the organization.

OrganizationType (example)

SummaryTrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • v2: No equivalent in v2
  • rim: .code
  • servd: n/a
Organization.nameΣ C
ShortName used for the organization
Definition

A name associated with the organization.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to use the name as the label of the organization.

Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XON.1
  • rim: .name
  • interface: Participant.name
  • servd: .PreferredName/Name
Organization.alias
ShortA list of alternate names that the organization is known as, or was known as in the past
Definition

A list of alternate names that the organization is known as, or was known as in the past.

Cardinality0..*
Typestring
Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .name
Organization.descriptionΣ
ShortAdditional details about the Organization that could be displayed as further information to identify the Organization beyond its name
Definition

Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.

Cardinality0..1
Typemarkdown
SummaryTrue
Requirements

Humans need additional information to verify a correct Organization has been selected.

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .playingEntity[classCode=PLC determinerCode=INSTANCE].desc
Organization.contactC
ShortOfficial contact details for the Organization
Definition

The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Cardinality0..*
TypeExtendedContactDetail
Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • org-4: The address of an organization can never be of use 'home'
    address.where(use = 'home').empty()
  • org-3: The telecom of an organization can never be of use 'home'
    telecom.where(use = 'home').empty()
Mappings
  • rim: n/a
  • rim: .contactParty
Organization.partOfΣ C
ShortThe organization of which this organization forms a part
Definition

The organization of which this organization forms a part.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Requirements

Need to be able to track the hierarchy of organizations within an organization.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: No equivalent in HL7 V2
  • rim: .playedBy[classCode=Part].scoper
  • servd: n/a
Organization.endpointC
ShortTechnical endpoints providing access to services operated for the organization
Definition

Technical endpoints providing access to services operated for the organization.

Cardinality0..*
TypeReference(Endpoint)
Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Organization.qualification
ShortQualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
Definition

The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.

For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.

Cardinality0..*
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CER?
Organization.qualification.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Organization.qualification.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.qualification.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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.

Comments

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Organization.qualification.identifierC
ShortAn identifier for this qualification for the organization
Definition

An identifier allocated to this qualification for this organization.

Cardinality0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the qualification by the assigning organization.

Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - 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
Organization.qualification.code
ShortCoded representation of the qualification
Definition

Coded representation of the qualification.

Cardinality1..1
TypeCodeableConcept
Binding

Specific qualification the organization has to provide a service.

(unbound) (example)

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Organization.qualification.periodC
ShortPeriod during which the qualification is valid
Definition

Period during which the qualification is valid.

Cardinality0..1
TypePeriod
Requirements

Qualifications are often for a limited period of time, and can be revoked.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower or equal value than end
    start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
Organization.qualification.issuerC
ShortOrganization that regulates and issues the qualification
Definition

Organization that regulates and issues the qualification.

Cardinality0..1
TypeReference(Organization)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="organization-data-access" />
<url value="http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access" />
<version value="0.0.1" />
<name value="OrganizationDataAccess" />
<status value="draft" />
<description value="Profile for organization, organizational unit or EU country in a data access domain." />
<fhirVersion value="5.0.0" />
<kind value="resource" />
<abstract value="false" />
<type value="Organization" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" />
<derivation value="constraint" />
<element id="Organization.identifier">
<path value="Organization.identifier" />
<type value="value" />
<path value="system" />
</discriminator>
<description value="Slice on identifier based on system value" />
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:organizationIdentifier">
<path value="Organization.identifier" />
<sliceName value="organizationIdentifier" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:organizationIdentifier.system">
<path value="Organization.identifier.system" />
<min value="1" />
<fixedUri value="urn:oid:2.5.4.97" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:organizationIdentifier.value">
<path value="Organization.identifier.value" />
<min value="1" />
<key value="ndi-organization-identifier-value-1" />
<severity value="error" />
<human value="A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057" />
<expression value="value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Organization.identifier:hvoOrganizationalUnitId">
<path value="Organization.identifier" />
<sliceName value="hvoOrganizationalUnitId" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:hvoOrganizationalUnitId.system">
<path value="Organization.identifier.system" />
<min value="1" />
<fixedUri value="http://electronichealth.se/identifier/HVO/organization" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:hvoOrganizationalUnitId.value">
<path value="Organization.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:countryCode">
<path value="Organization.identifier" />
<sliceName value="countryCode" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:countryCode.system">
<path value="Organization.identifier.system" />
<min value="1" />
<fixedUri value="urn:iso:std:iso:3166" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:countryCode.value">
<path value="Organization.identifier.value" />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://terminology.hl7.org/ValueSet/v3-Country2" />
</binding>
</element>
<element id="Organization.identifier:personalIdentityNumber">
<path value="Organization.identifier" />
<sliceName value="personalIdentityNumber" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:personalIdentityNumber.system">
<path value="Organization.identifier.system" />
<min value="1" />
<fixedUri value="http://electronichealth.se/identifier/personnummer" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:personalIdentityNumber.value">
<path value="Organization.identifier.value" />
<min value="1" />
<key value="ndi-personal-identity-number-value-1" />
<severity value="error" />
<human value="A Swedish personal identity number (sv: personnummer) should follow format 198001032385" />
<expression value="value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Organization.identifier:coordinationNumber">
<path value="Organization.identifier" />
<sliceName value="coordinationNumber" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:coordinationNumber.system">
<path value="Organization.identifier.system" />
<min value="1" />
<fixedUri value="http://electronichealth.se/identifier/samordningsnummer" />
<mustSupport value="true" />
</element>
<element id="Organization.identifier:coordinationNumber.value">
<path value="Organization.identifier.value" />
<min value="1" />
<key value="ndi-coordination-number-value-1" />
<severity value="error" />
<human value="A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399" />
<expression value="value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access" />
</constraint>
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "organization-data-access",
"url": "http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access",
"version": "0.0.1",
"name": "OrganizationDataAccess",
"status": "draft",
"description": "Profile for organization, organizational unit or EU country in a data access domain.",
"fhirVersion": "5.0.0",
"kind": "resource",
"abstract": false,
"type": "Organization",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
"derivation": "constraint",
"element": [
{
"id": "Organization.identifier",
"path": "Organization.identifier",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"description": "Slice on identifier based on system value",
"ordered": false,
"rules": "open"
},
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier:organizationIdentifier",
"path": "Organization.identifier",
"sliceName": "organizationIdentifier",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier:organizationIdentifier.system",
"path": "Organization.identifier.system",
"min": 1,
"fixedUri": "urn:oid:2.5.4.97",
"mustSupport": true
},
{
"id": "Organization.identifier:organizationIdentifier.value",
"path": "Organization.identifier.value",
"min": 1,
{
"key": "ndi-organization-identifier-value-1",
"severity": "error",
"human": "A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057",
"expression": "value.matches('^\\\\d{6}\\\\d{4}$') or system != 'urn:oid:2.5.4.97'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access"
}
],
"mustSupport": true
},
{
"id": "Organization.identifier:hvoOrganizationalUnitId",
"path": "Organization.identifier",
"sliceName": "hvoOrganizationalUnitId",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier:hvoOrganizationalUnitId.system",
"path": "Organization.identifier.system",
"min": 1,
"fixedUri": "http://electronichealth.se/identifier/HVO/organization",
"mustSupport": true
},
{
"id": "Organization.identifier:hvoOrganizationalUnitId.value",
"path": "Organization.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Organization.identifier:countryCode",
"path": "Organization.identifier",
"sliceName": "countryCode",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier:countryCode.system",
"path": "Organization.identifier.system",
"min": 1,
"fixedUri": "urn:iso:std:iso:3166",
"mustSupport": true
},
{
"id": "Organization.identifier:countryCode.value",
"path": "Organization.identifier.value",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-Country2"
}
},
{
"id": "Organization.identifier:personalIdentityNumber",
"path": "Organization.identifier",
"sliceName": "personalIdentityNumber",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier:personalIdentityNumber.system",
"path": "Organization.identifier.system",
"min": 1,
"fixedUri": "http://electronichealth.se/identifier/personnummer",
"mustSupport": true
},
{
"id": "Organization.identifier:personalIdentityNumber.value",
"path": "Organization.identifier.value",
"min": 1,
{
"key": "ndi-personal-identity-number-value-1",
"severity": "error",
"human": "A Swedish personal identity number (sv: personnummer) should follow format 198001032385",
"expression": "value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access"
}
],
"mustSupport": true
},
{
"id": "Organization.identifier:coordinationNumber",
"path": "Organization.identifier",
"sliceName": "coordinationNumber",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Organization.identifier:coordinationNumber.system",
"path": "Organization.identifier.system",
"min": 1,
"fixedUri": "http://electronichealth.se/identifier/samordningsnummer",
"mustSupport": true
},
{
"id": "Organization.identifier:coordinationNumber.value",
"path": "Organization.identifier.value",
"min": 1,
{
"key": "ndi-coordination-number-value-1",
"severity": "error",
"human": "A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399",
"expression": "value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access"
}
],
"mustSupport": true
}
]
}
}

Details

The red must-support flag ("S") indicates that the element is expected in some use cases, and a missing flag that the element is never used.