Page Status: draft updated 2024-12-20

HVOOrganization

Page index

Introduction
Overview
Details
Validation rules
Supported operations

Introduction

Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Resources.

Overview

HVOOrganization (Organization)	I		SEBaseOrganization	There are no (further) constraints on this element Element id Organization Short description A 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. Data type SEBaseOrganization 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().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()` 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: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
id	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Organization.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta 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
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Organization.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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 it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id Organization.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id Organization.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. Comments 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. Data type Narrative 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?
contained		0..*	Resource	There are no (further) constraints on this element Element id Organization.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	3..*	Extension	There are no (further) constraints on this element Element id Organization.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
organizationActive	S I	1..1	Extension(boolean)	Element id Organization.extension:organizationActive Short description HVOOrganizationActiveStatusExtension Alternate names extensions, user content Definition The status which the organization is registered with in SCB:s Business Register (sv: Företagsregister), where true implies 'active' and false implies 'inactive'. 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. Data type Extension(boolean) Extension URL http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension 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
legalForm	S I	1..1	Extension(Coding)	Element id Organization.extension:legalForm Short description HVOOrganizationLegalFormExtension Alternate names extensions, user content Definition Legal form of an organization. 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. Data type Extension(Coding) Extension URL http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension 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
ownershipType	S I	0..1	Extension(Coding)	Element id Organization.extension:ownershipType Short description HVOOrganizationOwnershipExtension Alternate names extensions, user content Definition HVO extension for organization ownership type 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. Data type Extension(Coding) Extension URL http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension 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
period	S I	1..1	Extension(Period)	Element id Organization.extension:period Short description Optional Extensions Element Alternate names extensions, user content Definition The date range that this organization should be considered available. 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. Data type Extension(Period) Extension URL http://hl7.org/fhir/StructureDefinition/organization-period 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
additionalRelationship	S I	0..*	Extension(Complex)	Element id Organization.extension:additionalRelationship Short description HVOOrganizationAdditionalRelationshipExtension Alternate names extensions, user content Definition Extension for Organization to supply potential relationships between organizations, for example that an organization owns or is owned by another organization. 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. Data type Extension(Complex) Extension URL http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAdditionalRelationshipExtension 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
qualification	S I	0..*	Extension	Element id Organization.extension:qualification Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Extension URL http://hl7.org/fhir/5.0/StructureDefinition/extension-Organization.qualification 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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 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). 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. Data type Extension Sliced: 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
identifier	S Σ I	1..*	Identifier	Element id Organization.identifier Short description Identifier for the organization. The organization should contain at least an organization number if legal form is corporation or a person number if legal form is sole trader. Can contain additional identifiers used in a national or local context. Definition Identifier for the organization that is used to identify the organization across multiple disparate systems. 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. Data type Identifier Sliced: Unordered, Open, by system(Value) Slice for swedish organization ID Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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) servd: ./Identifiers
(All Slices)				There are no (further) constraints on this element
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. 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. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) 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
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Organization.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 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
value	S Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier.value Short description The 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. 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 Rendered Value extension. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 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
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. 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. Data type Period 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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` 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
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. 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. Data type Reference(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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` 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
hsaid	S Σ I	0..1	Identifier	There are no (further) constraints on this element Element id Organization.identifier:hsaid Short description Identifies this organization across multiple systems Definition Identifier for the organization that is used to identify the organization across multiple disparate systems. 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. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:hsaid.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier:hsaid.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:hsaid.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. 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. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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
type	Σ	0..1	CodeableConceptBindingFixed Value	There are no (further) constraints on this element Element id Organization.identifier:hsaid.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN" } ] } 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
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Organization.identifier:hsaid.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value urn:oid:1.2.752.29.4.19 Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ I	1..1	string	Element id Organization.identifier:hsaid.value Short description The 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. 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 Rendered Value extension. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-hsa-identifier-value-1: If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters `$this.length() <= 31` hvo-organization-hsa-identifier-value-2: If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE<organization number>-XXX. Characters å, ä, ö, @ not valid. `$this.matches('^SE[0-9]{10}-[A-za-z0-9]+$')` Examples General 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
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:hsaid.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. 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. Data type Period 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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` 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
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:hsaid.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. 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. Data type Reference(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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` 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
organizationIdentifier	S Σ I	0..1	Identifier	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier Short description Identifies this organization across multiple systems Definition Identifier for the organization that is used to identify the organization across multiple disparate systems. 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. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. 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. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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
type	Σ	0..1	CodeableConceptBindingFixed Value	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } ] } 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
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Data type uri 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 Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ I	1..1	string	Element id Organization.identifier:organizationIdentifier.value Short description The 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. 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 Rendered Value extension. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-identifier-value-1: If identifier.system = urn:oid:2.5.4.97, value should follow format for organization identifier (sv: organisationsnummer): 10 digits 0-9 `$this.matches('^[0-9]{10}$')` Examples General 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
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. 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. Data type Period 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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` 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
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:organizationIdentifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. 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. Data type Reference(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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` 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
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element id Organization.active Short description Whether the organization's record is still in active use Definition Whether the organization's record is still in active use. 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 Data type boolean 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 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.
type	S Σ	1..*	CodeableConceptBinding	Element id Organization.type Short description Kind of organization Definition The kind(s) of organization that this is. 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. Data type CodeableConcept Sliced: Unordered, Open, by coding.code(Value) Slice on CodeableConcept based on the coding.code Binding Used to categorize the organization. hvo-organization-type (required) 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
(All Slices)				There are no (further) constraints on this element
id		0..1	string	There are no (further) constraints on this element Element id Organization.type.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.type.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
coding	S Σ	1..1	Coding	There are no (further) constraints on this element Element id Organization.type.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding 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 subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Organization.type.coding.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.type.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Organization.type.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	S Σ	0..1	string	There are no (further) constraints on this element Element id Organization.type.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	1..1	code	There are no (further) constraints on this element Element id Organization.type.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.type.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Organization.type.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.type.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
careProvider	S Σ	0..1	CodeableConceptBinding	Element id Organization.type:careProvider Short description Kind of organization Definition The kind(s) of organization that this is. 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. Data type CodeableConcept Binding Used to categorize the organization. SEBaseHSAVerksamhetVS (extensible) 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
id		0..1	string	There are no (further) constraints on this element Element id Organization.type:careProvider.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.type:careProvider.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
coding	S Σ	1..1	CodingPattern	Element id Organization.type:careProvider.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "system": "http://snomed.info/sct", "version": "http://snomed.info/sct/45991000052106", "code": "143591000052106" } Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
system	S Σ	1..1	uriPattern	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern http://snomed.info/sct Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	S Σ	0..1	stringPattern	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern http://snomed.info/sct/45991000052106 Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	1..1	codePattern	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern 143591000052106 Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Organization.type:careProvider.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.type:careProvider.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
name	S Σ I	1..1	string	Element id Organization.name Short description Name of the organization according to Bolagsverket, Skatteverket or SCB. Definition A name associated with the organization. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-name-1: Name of Organization should have max length of 200 characters `$this.length() <= 200` Mappings rim: n/a v2: XON.1 rim: .name servd: .PreferredName/Name
alias	S I	0..*	string	Element id Organization.alias Short description A name of the organization that is commonly used and is not the official name, e.g. an abbreviation of the official name. Definition A list of alternate names that the organization is known as, or was known as in the past. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-name-1: Name of Organization should have max length of 200 characters `$this.length() <= 200` Mappings rim: n/a rim: .name
telecom	S I	0..0	ContactPoint	There are no (further) constraints on this element Element id Organization.telecom Short description A contact detail for the organization Definition A contact detail for the organization. Requirements Human contact for the organization. Comments The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: ORC-22? rim: .telecom servd: ./ContactPoints
address	S I	0..0	Address	There are no (further) constraints on this element Element id Organization.address Short description An address for the organization Definition An address for the organization. Requirements May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Comments Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings rim: n/a v2: XAD rim: AD servd: Address v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
partOf	S Σ I	0..1	Reference(HVOOrganization)	Element id Organization.partOf Short description The organization of which this organization forms a part Definition The organization of which this organization forms a part. 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 resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(HVOOrganization) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` 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
contact	S	0..*	BackboneElement	There are no (further) constraints on this element Element id Organization.contact Short description Contact for the organization for a certain purpose Definition Contact for the organization for a certain purpose. Requirements Need to keep track of assigned contact points within bigger organization. Comments Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .contactParty
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 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). 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. Data type Extension 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
purpose	S	0..1	CodeableConceptBinding	Element id Organization.contact.purpose Short description The type of contact Definition Indicates a purpose for which the contact can be reached. Requirements Need to distinguish between multiple contact persons. 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. Data type CodeableConcept Binding The purpose for which you would contact a contact party. hvo-contact-purpose (required) 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 rim: ./type
name	S	0..1	HumanName	There are no (further) constraints on this element Element id Organization.contact.name Short description A name associated with the contact Definition A name associated with the contact. Requirements Need to be able to track the person by name. Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: PID-5, PID-9 rim: ./name
telecom	S I	0..*	ContactPoint	Element id Organization.contact.telecom Short description Contact details (telephone, email, etc.) for a contact Definition A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` hvo-telecom-phone-1: If telecom.system = #phone, value should follow format +(1-9)XXXX `value.matches('^\\+[1-9][0-9]+$') or system != 'phone'` hvo-telecom-phone-2: If telecom.system = #phone, value should have max length of 32 characters `value.length() <= 32 or system != 'phone'` hvo-telecom-url-2: If telecom.system = #url, value should have max length of 2000 characters `value.length() <= 2000 or system != 'url'` hvo-telecom-email-1: If telecom.system = #email, value should follow format xxx@xxx.xxx `value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email'` hvo-telecom-email-2: If telecom.system = #email, value should have max length of 255 characters `value.length() <= 255 or system != 'email'` hvo-telecom-url-1: If telecom.system = #url, value should follow valid format `value.matches('(https?\|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s])?$') or system != 'url'` Mappings* rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: PID-13, PID-14 rim: ./telecom
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.telecom.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.telecom.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
system	S Σ I	1..1	codeBinding	There are no (further) constraints on this element Element id Organization.contact.telecom.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	S Σ I	1..1	string	Element id Organization.contact.telecom.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-telecom-value-1: A telecom value should have max length of 2000 characters `$this.length() <= 2000` Mappings rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.contact.telecom.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id Organization.contact.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt 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
period	S Σ I	1..1	Period	There are no (further) constraints on this element Element id Organization.contact.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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. Data type Period 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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.telecom.period.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.telecom.period.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
start	S Σ I	1..1	dateTime	There are no (further) constraints on this element Element id Organization.contact.telecom.period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: DR.1 rim: ./low
end	S Σ I	0..1	dateTime	There are no (further) constraints on this element Element id Organization.contact.telecom.period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Meaning when missing If the end of the period is missing, it means that the period is ongoing Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: DR.2 rim: ./high
address	S	0..1	Address	There are no (further) constraints on this element Element id Organization.contact.address Short description Visiting or postal addresses for the contact Definition Visiting or postal addresses for the contact. Requirements May need to keep track of a contact party's address for contacting, billing or reporting requirements. Comments Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XAD rim: AD servd: Address v2: PID-11 rim: ./addr
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.address.id Short description Unique 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. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.address.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.contact.address.use Short description home \| work \| temp \| old \| billing - purpose of this address Definition The purpose of this address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data type code Binding The use of an address. AddressUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim: n/a v2: XAD.7 rim: unique(./use) servd: ./AddressPurpose
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.contact.address.type Short description postal \| physical \| both Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim: n/a v2: XAD.18 rim: unique(./use) vcard: address type parameter
text	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.contact.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim: n/a v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim: ./formatted vcard: address label parameter
line	S Σ I	0..*	string	Element id Organization.contact.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-address-line-1: An address line should have max length of 128 characters `$this.length() <= 128` Examples General 137 Nowhere Street Mappings rim: n/a v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim: AD.part[parttype = AL] vcard: street servd: ./StreetAddress (newline delimitted)
city	S Σ I	0..1	string	Element id Organization.contact.address.city Short description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-address-city-1: An address city should have a max length of 50 characters `$this.length() <= 50` Examples General Erewhon Mappings rim: n/a v2: XAD.3 rim: AD.part[parttype = CTY] vcard: locality servd: ./Jurisdiction
district	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.contact.address.district Short description District name (aka county) Alternate names County Definition The name of the administrative area (county). Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim: n/a v2: XAD.9 rim: AD.part[parttype = CNT \| CPA]
state	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.contact.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XAD.4 rim: AD.part[parttype = STA] vcard: region servd: ./Region
postalCode	S Σ	0..1	string	There are no (further) constraints on this element Element id Organization.contact.address.postalCode Short description Postal code for area Alternate names Zip Definition A postal code designating a region defined by the postal service. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim: n/a v2: XAD.5 rim: AD.part[parttype = ZIP] vcard: code servd: ./PostalIdentificationCode
country	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.contact.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments ISO 3166 3 letter codes can be used in place of a human readable country name. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XAD.6 rim: AD.part[parttype = CNT] vcard: country servd: ./Country
period	Σ I	0..1	Period	There are no (further) constraints on this element Element id Organization.contact.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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. Data type Period 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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: XAD.12 / XAD.13 + XAD.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id Organization.endpoint Short description Technical endpoints providing access to services operated for the organization Definition Technical endpoints providing access to services operated for the organization. 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 resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Endpoint) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Organization
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.
Cardinality	0...*
Invariants	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().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()` 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: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
Organization.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Organization.meta
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.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	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
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.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
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 it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Organization.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
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).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Organization.text
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.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	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.
Invariants	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.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline 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.
Mappings	rim: Entity. Role, or Act rim: N/A
Organization.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	3...*
Type	Extension
Alias	extensions, 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)
Invariants	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.extension:organizationActive
Definition	The status which the organization is registered with in SCB:s Business Register (sv: Företagsregister), where true implies 'active' and false implies 'inactive'.
Cardinality	1...1
Type	Extension(boolean)
Must Support	True
Alias	extensions, 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.
Invariants	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.extension:legalForm
Definition	Legal form of an organization.
Cardinality	1...1
Type	Extension(Coding)
Must Support	True
Alias	extensions, 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.
Invariants	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.extension:ownershipType
Definition	HVO extension for organization ownership type
Cardinality	0...1
Type	Extension(Coding)
Must Support	True
Alias	extensions, 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.
Invariants	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.extension:period
Definition	The date range that this organization should be considered available.
Cardinality	1...1
Type	Extension(Period)
Must Support	True
Alias	extensions, 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.
Invariants	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.extension:additionalRelationship
Definition	Extension for Organization to supply potential relationships between organizations, for example that an organization owns or is owned by another organization.
Cardinality	0...*
Type	Extension(Complex)
Must Support	True
Alias	extensions, 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.
Invariants	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.extension:qualification
Definition	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Must Support	True
Alias	extensions, 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.
Invariants	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
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 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).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, 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)
Invariants	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
Definition	Identifier for the organization that is used to identify the organization across multiple disparate systems.
Cardinality	1...*
Type	Identifier
Must Support	True
Summary	True
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.
Slicing	Unordered, Open, by system(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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) servd: ./Identifiers
Organization.identifier.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.identifier.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
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.
Invariants	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.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
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.
Invariants	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.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Must Support	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 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.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Must Support	True
Summary	True
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 Rendered Value extension. 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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 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.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
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.
Invariants	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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
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.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
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.
Invariants	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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
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:hsaid
Definition	Identifier for the organization that is used to identify the organization across multiple disparate systems.
Cardinality	0...1
Type	Identifier
Must Support	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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) servd: ./Identifiers
Organization.identifier:hsaid.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.identifier:hsaid.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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:hsaid.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
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.
Invariants	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:hsaid.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN" } ] }
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:hsaid.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Must Support	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	urn:oid:1.2.752.29.4.19
Mappings	rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Organization.identifier:hsaid.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Must Support	True
Summary	True
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 Rendered Value extension. 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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-hsa-identifier-value-1: If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters `$this.length() <= 31` hvo-organization-hsa-identifier-value-2: If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE<organization number>-XXX. Characters å, ä, ö, @ not valid. `$this.matches('^SE[0-9]{10}-[A-za-z0-9]+$')`
Examples	General 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:hsaid.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
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.
Invariants	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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
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:hsaid.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
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.
Invariants	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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
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:organizationIdentifier
Definition	Identifier for the organization that is used to identify the organization across multiple disparate systems.
Cardinality	0...1
Type	Identifier
Must Support	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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) servd: ./Identifiers
Organization.identifier:organizationIdentifier.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.identifier:organizationIdentifier.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
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.
Invariants	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
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "XX" } ] }
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.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Must Support	True
Summary	True
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.
Invariants	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
Mappings	rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Organization.identifier:organizationIdentifier.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Must Support	True
Summary	True
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 Rendered Value extension. 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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-identifier-value-1: If identifier.system = urn:oid:2.5.4.97, value should follow format for organization identifier (sv: organisationsnummer): 10 digits 0-9 `$this.matches('^[0-9]{10}$')`
Examples	General 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
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
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.
Invariants	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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
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
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
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.
Invariants	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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
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
Definition	Whether the organization's record is still in active use.
Cardinality	0...1
Type	boolean
Modifier	True
Summary	True
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.
Invariants	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 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
Definition	The kind(s) of organization that this is.
Cardinality	1...*
Type	CodeableConcept
Binding	Used to categorize the organization. hvo-organization-type (required)
Must Support	True
Summary	True
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.
Slicing	Unordered, Open, by coding.code(Value)
Invariants	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.type.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.type.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.type.coding
Definition	A reference to a code defined by a terminology system.
Cardinality	1...1
Type	Coding
Must Support	True
Summary	True
Requirements	Allows for alternative encodings within a code system, and translations to other code systems.
Comments	Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants	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 subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Organization.type.coding.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.type.coding.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.type.coding.system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1...1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Organization.type.coding.version
Definition	The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Organization.type.coding.code
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	1...1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Organization.type.coding.display
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0...1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Organization.type.coding.userSelected
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0...1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Organization.type.text
Definition	A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality	0...1
Type	string
Summary	True
Requirements	The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments	Very often the text is the same as a displayName of one of the codings.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Organization.type:careProvider
Definition	The kind(s) of organization that this is.
Cardinality	0...1
Type	CodeableConcept
Binding	Used to categorize the organization. SEBaseHSAVerksamhetVS (extensible)
Must Support	True
Summary	True
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.
Invariants	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.type:careProvider.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.type:careProvider.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.type:careProvider.coding
Definition	A reference to a code defined by a terminology system.
Cardinality	1...1
Type	Coding
Must Support	True
Summary	True
Requirements	Allows for alternative encodings within a code system, and translations to other code systems.
Comments	Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Pattern	{ "system": "http://snomed.info/sct", "version": "http://snomed.info/sct/45991000052106", "code": "143591000052106" }
Mappings	rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Organization.type:careProvider.coding.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.type:careProvider.coding.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.type:careProvider.coding.system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1...1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Pattern	http://snomed.info/sct
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Organization.type:careProvider.coding.version
Definition	The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Pattern	http://snomed.info/sct/45991000052106
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Organization.type:careProvider.coding.code
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	1...1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Pattern	143591000052106
Mappings	rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Organization.type:careProvider.coding.display
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0...1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Organization.type:careProvider.coding.userSelected
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0...1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Organization.type:careProvider.text
Definition	A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality	0...1
Type	string
Summary	True
Requirements	The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments	Very often the text is the same as a displayName of one of the codings.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Organization.name
Definition	A name associated with the organization.
Cardinality	1...1
Type	string
Must Support	True
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-name-1: Name of Organization should have max length of 200 characters `$this.length() <= 200`
Mappings	rim: n/a v2: XON.1 rim: .name servd: .PreferredName/Name
Organization.alias
Definition	A list of alternate names that the organization is known as, or was known as in the past.
Cardinality	0...*
Type	string
Must Support	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-organization-name-1: Name of Organization should have max length of 200 characters `$this.length() <= 200`
Mappings	rim: n/a rim: .name
Organization.telecom
Definition	A contact detail for the organization.
Cardinality	0...0
Type	ContactPoint
Must Support	True
Requirements	Human contact for the organization.
Comments	The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()`
Mappings	rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: ORC-22? rim: .telecom servd: ./ContactPoints
Organization.address
Definition	An address for the organization.
Cardinality	0...0
Type	Address
Must Support	True
Requirements	May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
Comments	Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()`
Mappings	rim: n/a v2: XAD rim: AD servd: Address v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
Organization.partOf
Definition	The organization of which this organization forms a part.
Cardinality	0...1
Type	Reference(HVOOrganization)
Must Support	True
Summary	True
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 resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
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.contact
Definition	Contact for the organization for a certain purpose.
Cardinality	0...*
Type	BackboneElement
Must Support	True
Requirements	Need to keep track of assigned contact points within bigger organization.
Comments	Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: .contactParty
Organization.contact.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.contact.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.contact.modifierExtension
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 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).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, 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.
Invariants	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.contact.purpose
Definition	Indicates a purpose for which the contact can be reached.
Cardinality	0...1
Type	CodeableConcept
Binding	The purpose for which you would contact a contact party. hvo-contact-purpose (required)
Must Support	True
Requirements	Need to distinguish between multiple contact persons.
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.
Invariants	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 rim: ./type
Organization.contact.name
Definition	A name associated with the contact.
Cardinality	0...1
Type	HumanName
Must Support	True
Requirements	Need to be able to track the person by name.
Comments	Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: PID-5, PID-9 rim: ./name
Organization.contact.telecom
Definition	A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Requirements	People have (primary) ways to contact them in some way such as phone, email.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` hvo-telecom-phone-1: If telecom.system = #phone, value should follow format +(1-9)XXXX `value.matches('^\\+[1-9][0-9]+$') or system != 'phone'` hvo-telecom-phone-2: If telecom.system = #phone, value should have max length of 32 characters `value.length() <= 32 or system != 'phone'` hvo-telecom-url-2: If telecom.system = #url, value should have max length of 2000 characters `value.length() <= 2000 or system != 'url'` hvo-telecom-email-1: If telecom.system = #email, value should follow format xxx@xxx.xxx `value.matches('^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$') or system != 'email'` hvo-telecom-email-2: If telecom.system = #email, value should have max length of 255 characters `value.length() <= 255 or system != 'email'` hvo-telecom-url-1: If telecom.system = #url, value should follow valid format `value.matches('(https?\|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$') or system != 'url'`
Mappings	rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: PID-13, PID-14 rim: ./telecom
Organization.contact.telecom.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.contact.telecom.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.contact.telecom.system
Definition	Telecommunications form for contact point - what communications system is required to make use of the contact.
Cardinality	1...1
Type	code
Binding	Telecommunications form for contact point. ContactPointSystem (required)
Must Support	True
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XTN.3 rim: ./scheme servd: ./ContactPointType
Organization.contact.telecom.value
Definition	The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Cardinality	1...1
Type	string
Must Support	True
Summary	True
Requirements	Need to support legacy numbers that are not in a tightly controlled format.
Comments	Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-telecom-value-1: A telecom value should have max length of 2000 characters `$this.length() <= 2000`
Mappings	rim: n/a v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
Organization.contact.telecom.use
Definition	Identifies the purpose for the contact point.
Cardinality	0...1
Type	code
Binding	Use of contact point. ContactPointUse (required)
Modifier	True
Summary	True
Requirements	Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments	Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
Organization.contact.telecom.rank
Definition	Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Cardinality	0...1
Type	positiveInt
Summary	True
Comments	Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: n/a
Organization.contact.telecom.period
Definition	Time period when the contact point was/is in use.
Cardinality	1...1
Type	Period
Must Support	True
Summary	True
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.
Invariants	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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
Mappings	rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
Organization.contact.telecom.period.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.contact.telecom.period.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.contact.telecom.period.start
Definition	The start of the period. The boundary is inclusive.
Cardinality	1...1
Type	dateTime
Must Support	True
Summary	True
Comments	If the low element is missing, the meaning is that the low boundary is not known.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: DR.1 rim: ./low
Organization.contact.telecom.period.end
Definition	The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Cardinality	0...1
Type	dateTime
Must Support	True
Summary	True
Comments	The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: DR.2 rim: ./high
Organization.contact.address
Definition	Visiting or postal addresses for the contact.
Cardinality	0...1
Type	Address
Must Support	True
Requirements	May need to keep track of a contact party's address for contacting, billing or reporting requirements.
Comments	Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XAD rim: AD servd: Address v2: PID-11 rim: ./addr
Organization.contact.address.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Organization.contact.address.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, 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)
Invariants	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.contact.address.use
Definition	The purpose of this address.
Cardinality	0...1
Type	code
Binding	The use of an address. AddressUse (required)
Modifier	True
Summary	True
Requirements	Allows an appropriate address to be chosen from a list of many.
Comments	Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General home
Mappings	rim: n/a v2: XAD.7 rim: unique(./use) servd: ./AddressPurpose
Organization.contact.address.type
Definition	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Cardinality	0...1
Type	code
Binding	The type of an address (physical / postal). AddressType (required)
Summary	True
Comments	The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General both
Mappings	rim: n/a v2: XAD.18 rim: unique(./use) vcard: address type parameter
Organization.contact.address.text
Definition	Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Cardinality	0...1
Type	string
Summary	True
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 137 Nowhere Street, Erewhon 9132
Mappings	rim: n/a v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim: ./formatted vcard: address label parameter
Organization.contact.address.line
Definition	This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Cardinality	0...*
Type	string
Must Support	True
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-address-line-1: An address line should have max length of 128 characters `$this.length() <= 128`
Examples	General 137 Nowhere Street
Mappings	rim: n/a v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim: AD.part[parttype = AL] vcard: street servd: ./StreetAddress (newline delimitted)
Organization.contact.address.city
Definition	The name of the city, town, suburb, village or other community or delivery center.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Alias	Municpality
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hvo-address-city-1: An address city should have a max length of 50 characters `$this.length() <= 50`
Examples	General Erewhon
Mappings	rim: n/a v2: XAD.3 rim: AD.part[parttype = CTY] vcard: locality servd: ./Jurisdiction
Organization.contact.address.district
Definition	The name of the administrative area (county).
Cardinality	0...1
Type	string
Summary	True
Alias	County
Comments	District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General Madison
Mappings	rim: n/a v2: XAD.9 rim: AD.part[parttype = CNT \| CPA]
Organization.contact.address.state
Definition	Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Cardinality	0...1
Type	string
Summary	True
Alias	Province, Territory
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XAD.4 rim: AD.part[parttype = STA] vcard: region servd: ./Region
Organization.contact.address.postalCode
Definition	A postal code designating a region defined by the postal service.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Alias	Zip
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 9132
Mappings	rim: n/a v2: XAD.5 rim: AD.part[parttype = ZIP] vcard: code servd: ./PostalIdentificationCode
Organization.contact.address.country
Definition	Country - a nation as commonly understood or generally accepted.
Cardinality	0...1
Type	string
Summary	True
Comments	ISO 3166 3 letter codes can be used in place of a human readable country name.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: XAD.6 rim: AD.part[parttype = CNT] vcard: country servd: ./Country
Organization.contact.address.period
Definition	Time period when address was/is in use.
Cardinality	0...1
Type	Period
Summary	True
Requirements	Allows addresses to be placed in historical context.
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.
Invariants	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 value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)`
Examples	General { "start": "2010-03-23", "end": "2010-07-01" }
Mappings	rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: XAD.12 / XAD.13 + XAD.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
Organization.endpoint
Definition	Technical endpoints providing access to services operated for the organization.
Cardinality	0...*
Type	Reference(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 resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
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="HVOOrganization" />
    <url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
    <version value="0.1.0" />
    <name value="HVOOrganization" />
    <title value="HVOOrganization" />
    <status value="draft" />
    <description value="HVOOrganization holds information about corporations and sole traders." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Organization" />
    <baseDefinition value="http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOrganization" />
    <derivation value="constraint" />
    <differential>
        <element id="Organization.extension">
            <path value="Organization.extension" />
            <min value="3" />
        </element>
        <element id="Organization.extension:organizationActive">
            <path value="Organization.extension" />
            <sliceName value="organizationActive" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.extension:legalForm">
            <path value="Organization.extension" />
            <sliceName value="legalForm" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.extension:ownershipType">
            <path value="Organization.extension" />
            <sliceName value="ownershipType" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.extension:period">
            <path value="Organization.extension" />
            <sliceName value="period" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/organization-period" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.extension:additionalRelationship">
            <path value="Organization.extension" />
            <sliceName value="additionalRelationship" />
            <min value="0" />
            <max value="*" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAdditionalRelationshipExtension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.extension:qualification">
            <path value="Organization.extension" />
            <sliceName value="qualification" />
            <min value="0" />
            <max value="*" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Organization.qualification" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier">
            <path value="Organization.identifier" />
            <short value="Identifier for the organization. The organization should contain at least an organization number if legal form is corporation or a person number if legal form is sole trader. Can contain additional identifiers used in a national or local context." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:hsaid">
            <path value="Organization.identifier" />
            <sliceName value="hsaid" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:hsaid.system">
            <path value="Organization.identifier.system" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:hsaid.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
            <constraint>
                <key value="hvo-organization-hsa-identifier-value-1" />
                <severity value="warning" />
                <human value="If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters" />
                <expression value="$this.length() &lt;= 31" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <constraint>
                <key value="hvo-organization-hsa-identifier-value-2" />
                <severity value="warning" />
                <human value="If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE&lt;organization number&gt;-XXX. Characters &#229;, &#228;, &#246;, @ not valid." />
                <expression value="$this.matches(&#39;^SE[0-9]{10}-[A-za-z0-9]+$&#39;)" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:organizationIdentifier">
            <path value="Organization.identifier" />
            <sliceName value="organizationIdentifier" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:organizationIdentifier.system">
            <path value="Organization.identifier.system" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:organizationIdentifier.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
            <constraint>
                <key value="hvo-organization-identifier-value-1" />
                <severity value="warning" />
                <human value="If identifier.system = urn:oid:2.5.4.97, value should follow format for organization identifier (sv: organisationsnummer): 10 digits 0-9" />
                <expression value="$this.matches(&#39;^[0-9]{10}$&#39;)" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.type">
            <path value="Organization.type" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="coding.code" />
                </discriminator>
                <description value="Slice on CodeableConcept based on the coding.code" />
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-organization-type" />
            </binding>
        </element>
        <element id="Organization.type.coding">
            <path value="Organization.type.coding" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type.coding.system">
            <path value="Organization.type.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type.coding.version">
            <path value="Organization.type.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type.coding.code">
            <path value="Organization.type.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type:careProvider">
            <path value="Organization.type" />
            <sliceName value="careProvider" />
            <min value="0" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type:careProvider.coding">
            <path value="Organization.type.coding" />
            <min value="1" />
            <max value="1" />
            <patternCoding>
                <system value="http://snomed.info/sct" />
                <version value="http://snomed.info/sct/45991000052106" />
                <code value="143591000052106" />
            </patternCoding>
            <mustSupport value="true" />
        </element>
        <element id="Organization.type:careProvider.coding.system">
            <path value="Organization.type.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type:careProvider.coding.version">
            <path value="Organization.type.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type:careProvider.coding.code">
            <path value="Organization.type.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.name">
            <path value="Organization.name" />
            <short value="Name of the organization according to Bolagsverket, Skatteverket or SCB." />
            <min value="1" />
            <constraint>
                <key value="hvo-organization-name-1" />
                <severity value="warning" />
                <human value="Name of Organization should have max length of 200 characters" />
                <expression value="$this.length() &lt;= 200" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.alias">
            <path value="Organization.alias" />
            <short value="A name of the organization that is commonly used and is not the official name, e.g. an abbreviation of the official name." />
            <constraint>
                <key value="hvo-organization-name-1" />
                <severity value="warning" />
                <human value="Name of Organization should have max length of 200 characters" />
                <expression value="$this.length() &lt;= 200" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.telecom">
            <path value="Organization.telecom" />
            <max value="0" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.address">
            <path value="Organization.address" />
            <max value="0" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.partOf">
            <path value="Organization.partOf" />
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy">
                    <valueBoolean value="true" />
                </extension>
                <code value="Reference" />
                <targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact">
            <path value="Organization.contact" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.purpose">
            <path value="Organization.contact.purpose" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/hvo/ValueSet/hvo-contact-purpose" />
            </binding>
        </element>
        <element id="Organization.contact.name">
            <path value="Organization.contact.name" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.telecom">
            <path value="Organization.contact.telecom" />
            <constraint>
                <key value="hvo-telecom-phone-1" />
                <severity value="warning" />
                <human value="If telecom.system = #phone, value should follow format +(1-9)XXXX" />
                <expression value="value.matches(&#39;^\\+[1-9][0-9]+$&#39;) or system != &#39;phone&#39;" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <constraint>
                <key value="hvo-telecom-phone-2" />
                <severity value="warning" />
                <human value="If telecom.system = #phone, value should have max length of 32 characters" />
                <expression value="value.length() &lt;= 32 or system != &#39;phone&#39;" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <constraint>
                <key value="hvo-telecom-url-2" />
                <severity value="warning" />
                <human value="If telecom.system = #url, value should have max length of 2000 characters" />
                <expression value="value.length() &lt;= 2000 or system != &#39;url&#39;" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <constraint>
                <key value="hvo-telecom-email-1" />
                <severity value="warning" />
                <human value="If telecom.system = #email, value should follow format xxx@xxx.xxx" />
                <expression value="value.matches(&#39;^[\\w.-]{1,64}@(?!.{254})[\\w.-]+\\.[A-Za-z]{2,4}$&#39;) or system != &#39;email&#39;" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <constraint>
                <key value="hvo-telecom-email-2" />
                <severity value="warning" />
                <human value="If telecom.system = #email, value should have max length of 255 characters" />
                <expression value="value.length() &lt;= 255 or system != &#39;email&#39;" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <constraint>
                <key value="hvo-telecom-url-1" />
                <severity value="warning" />
                <human value="If telecom.system = #url, value should follow valid format" />
                <expression value="value.matches(&#39;(https?|ftp)://(-\\.)?([^\\s/?\\.#-]+\\.?)+(/[^\\s]*)?$&#39;) or system != &#39;url&#39;" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.telecom.system">
            <path value="Organization.contact.telecom.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.telecom.value">
            <path value="Organization.contact.telecom.value" />
            <min value="1" />
            <constraint>
                <key value="hvo-telecom-value-1" />
                <severity value="warning" />
                <human value="A telecom value should have max length of 2000 characters" />
                <expression value="$this.length() &lt;= 2000" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.telecom.period">
            <path value="Organization.contact.telecom.period" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.telecom.period.start">
            <path value="Organization.contact.telecom.period.start" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.telecom.period.end">
            <path value="Organization.contact.telecom.period.end" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.address">
            <path value="Organization.contact.address" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.address.line">
            <path value="Organization.contact.address.line" />
            <constraint>
                <key value="hvo-address-line-1" />
                <severity value="warning" />
                <human value="An address line should have max length of 128 characters" />
                <expression value="$this.length() &lt;= 128" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.address.city">
            <path value="Organization.contact.address.city" />
            <constraint>
                <key value="hvo-address-city-1" />
                <severity value="warning" />
                <human value="An address city should have a max length of 50 characters" />
                <expression value="$this.length() &lt;= 50" />
                <source value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="Organization.contact.address.postalCode">
            <path value="Organization.contact.address.postalCode" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "HVOOrganization",
    "url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
    "version": "0.1.0",
    "name": "HVOOrganization",
    "title": "HVOOrganization",
    "status": "draft",
    "description": "HVOOrganization holds information about corporations and sole traders.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Organization",
    "baseDefinition": "http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOrganization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization.extension",
                "path": "Organization.extension",
                "min": 3
            },
            {
                "id": "Organization.extension:organizationActive",
                "path": "Organization.extension",
                "sliceName": "organizationActive",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.extension:legalForm",
                "path": "Organization.extension",
                "sliceName": "legalForm",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationLegalFormExtension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.extension:ownershipType",
                "path": "Organization.extension",
                "sliceName": "ownershipType",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationOwnershipExtension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.extension:period",
                "path": "Organization.extension",
                "sliceName": "period",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/organization-period"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.extension:additionalRelationship",
                "path": "Organization.extension",
                "sliceName": "additionalRelationship",
                "min": 0,
                "max": "*",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationAdditionalRelationshipExtension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.extension:qualification",
                "path": "Organization.extension",
                "sliceName": "qualification",
                "min": 0,
                "max": "*",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/5.0/StructureDefinition/extension-Organization.qualification"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.identifier",
                "path": "Organization.identifier",
                "short": "Identifier for the organization. The organization should contain at least an organization number if legal form is corporation or a person number if legal form is sole trader. Can contain additional identifiers used in a national or local context.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.identifier.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.identifier.value",
                "path": "Organization.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:hsaid",
                "path": "Organization.identifier",
                "sliceName": "hsaid",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:hsaid.system",
                "path": "Organization.identifier.system",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:hsaid.value",
                "path": "Organization.identifier.value",
                "min": 1,
                "constraint":  [
                    {
                        "key": "hvo-organization-hsa-identifier-value-1",
                        "human": "If identifier.system = urn:oid:1.2.752.29.4.19, value should have max length of 31 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.length() <= 31"
                    },
                    {
                        "key": "hvo-organization-hsa-identifier-value-2",
                        "human": "If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE<organization number>-XXX. Characters å, ä, ö, @ not valid.",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.matches('^SE[0-9]{10}-[A-za-z0-9]+$')"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:organizationIdentifier",
                "path": "Organization.identifier",
                "sliceName": "organizationIdentifier",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:organizationIdentifier.system",
                "path": "Organization.identifier.system",
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:organizationIdentifier.value",
                "path": "Organization.identifier.value",
                "min": 1,
                "constraint":  [
                    {
                        "key": "hvo-organization-identifier-value-1",
                        "human": "If identifier.system = urn:oid:2.5.4.97, value should follow format for organization identifier (sv: organisationsnummer): 10 digits 0-9",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.matches('^[0-9]{10}$')"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.type",
                "path": "Organization.type",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "coding.code"
                        }
                    ],
                    "rules": "open",
                    "ordered": false,
                    "description": "Slice on CodeableConcept based on the coding.code"
                },
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-organization-type"
                }
            },
            {
                "id": "Organization.type.coding",
                "path": "Organization.type.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding.system",
                "path": "Organization.type.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding.version",
                "path": "Organization.type.coding.version",
                "mustSupport": true
            },
            {
                "id": "Organization.type.coding.code",
                "path": "Organization.type.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.type:careProvider",
                "path": "Organization.type",
                "sliceName": "careProvider",
                "min": 0,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Organization.type:careProvider.coding",
                "path": "Organization.type.coding",
                "min": 1,
                "max": "1",
                "patternCoding": {
                    "code": "143591000052106",
                    "system": "http://snomed.info/sct",
                    "version": "http://snomed.info/sct/45991000052106"
                },
                "mustSupport": true
            },
            {
                "id": "Organization.type:careProvider.coding.system",
                "path": "Organization.type.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.type:careProvider.coding.version",
                "path": "Organization.type.coding.version",
                "mustSupport": true
            },
            {
                "id": "Organization.type:careProvider.coding.code",
                "path": "Organization.type.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.name",
                "path": "Organization.name",
                "short": "Name of the organization according to Bolagsverket, Skatteverket or SCB.",
                "min": 1,
                "constraint":  [
                    {
                        "key": "hvo-organization-name-1",
                        "human": "Name of Organization should have max length of 200 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.length() <= 200"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.alias",
                "path": "Organization.alias",
                "short": "A name of the organization that is commonly used and is not the official name, e.g. an abbreviation of the official name.",
                "constraint":  [
                    {
                        "key": "hvo-organization-name-1",
                        "human": "Name of Organization should have max length of 200 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.length() <= 200"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.telecom",
                "path": "Organization.telecom",
                "max": "0",
                "mustSupport": true
            },
            {
                "id": "Organization.address",
                "path": "Organization.address",
                "max": "0",
                "mustSupport": true
            },
            {
                "id": "Organization.partOf",
                "path": "Organization.partOf",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization"
                        ],
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
                                "valueBoolean": true
                            }
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.contact",
                "path": "Organization.contact",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.purpose",
                "path": "Organization.contact.purpose",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/hvo/ValueSet/hvo-contact-purpose"
                }
            },
            {
                "id": "Organization.contact.name",
                "path": "Organization.contact.name",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom",
                "path": "Organization.contact.telecom",
                "constraint":  [
                    {
                        "key": "hvo-telecom-phone-1",
                        "human": "If telecom.system = #phone, value should follow format +(1-9)XXXX",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "value.matches('^\\\\+[1-9][0-9]+$') or system != 'phone'"
                    },
                    {
                        "key": "hvo-telecom-phone-2",
                        "human": "If telecom.system = #phone, value should have max length of 32 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "value.length() <= 32 or system != 'phone'"
                    },
                    {
                        "key": "hvo-telecom-url-2",
                        "human": "If telecom.system = #url, value should have max length of 2000 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "value.length() <= 2000 or system != 'url'"
                    },
                    {
                        "key": "hvo-telecom-email-1",
                        "human": "If telecom.system = #email, value should follow format xxx@xxx.xxx",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "value.matches('^[\\\\w.-]{1,64}@(?!.{254})[\\\\w.-]+\\\\.[A-Za-z]{2,4}$') or system != 'email'"
                    },
                    {
                        "key": "hvo-telecom-email-2",
                        "human": "If telecom.system = #email, value should have max length of 255 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "value.length() <= 255 or system != 'email'"
                    },
                    {
                        "key": "hvo-telecom-url-1",
                        "human": "If telecom.system = #url, value should follow valid format",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "value.matches('(https?|ftp)://(-\\\\.)?([^\\\\s/?\\\\.#-]+\\\\.?)+(/[^\\\\s]*)?$') or system != 'url'"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.system",
                "path": "Organization.contact.telecom.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.value",
                "path": "Organization.contact.telecom.value",
                "min": 1,
                "constraint":  [
                    {
                        "key": "hvo-telecom-value-1",
                        "human": "A telecom value should have max length of 2000 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.length() <= 2000"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.period",
                "path": "Organization.contact.telecom.period",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.period.start",
                "path": "Organization.contact.telecom.period.start",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.contact.telecom.period.end",
                "path": "Organization.contact.telecom.period.end",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address",
                "path": "Organization.contact.address",
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.line",
                "path": "Organization.contact.address.line",
                "constraint":  [
                    {
                        "key": "hvo-address-line-1",
                        "human": "An address line should have max length of 128 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.length() <= 128"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.city",
                "path": "Organization.contact.address.city",
                "constraint":  [
                    {
                        "key": "hvo-address-city-1",
                        "human": "An address city should have a max length of 50 characters",
                        "source": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
                        "severity": "warning",
                        "expression": "$this.length() <= 50"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.contact.address.postalCode",
                "path": "Organization.contact.address.postalCode",
                "mustSupport": true
            }
        ]
    }
}

Details

Validation rules

Operational rules

Operational rules are validation rules and logic which the Swedish eHealth Agency is responsible for. The operational rules which are relevant for this resource are listed below.

Rule ID	Name	Description	Error code	Error message

Other rules

Name	Description	Error code	Error message

Supported operations

HTTP methods

Operation	Supported	Comment
Search (GET, POST)	yes	Kommentar
Insert (POST)	yes	Kommentar
Update (PUT)	yes/no	Kommentar
Delete (DEL)	yes/no	Kommentar
Operation (GET, POST)	yes	Kommentar

Query operations

Supported Queries

.../Organization returns all Organizations.
.../Organization/[LogicalId] returns the Organization with the supplied logical ID.
.../Organization?[parameters] and .../Organization/_search?[parameters]
Parameter chains:

identifier=urn:oid:1.2.752.29.4.19|[hsaid] returns the Organization with the supplied HSA ID.
identifier=urn:oid:2.5.4.97|[organizationIdentifier] returns the Organization with the supplied organization identifier (sv: organisationsnummer).
type=[Type] returns a list of Organizations with the supplied type.
name:contains=[Name]&type=[Type] returns a list of Organizations which names contain the supplied name and have the supplied type.
_id=[LogicalId1,LogicalId2] returns a list of Organizations with the provided logical IDs.
partof

Compartment searches

Supported searches on a compartment. This kind of search returns a bundle with the related resources.

Search parameters

Parameter	Description	Comment
Organization/[LogicalId]	A read based on the logical ID (UUID) of an Organization.
_id	Logical ID (UUID) of an Organization.
name:contains	At least three letters of the name of an Organization.
type	Type of Organization.
identifier	External ID of an Organization.	Includes OID for type of external ID.

Other operations

HVOOrganizationalUnitsWithBusinessById

Operation name	HTTP verbs	Link
$hvo-organizational-units-with-business	GET	HVOOrganizationalUnitsWithBusinessById

Invocations

URL: [base]/Organization/id/$organizational-units-with-business-by-id

This operation does NOT change content

This operation is a namedQuery

Parameters (In)

Name	Cardinality	Type	Documentation
id	1..1	string	Logical ID (UUID) of HVOOrganization or HVOOrganizationalUnit
name:contains	0..1	string	Search string of name of HVOOrganization or HVOOrganizationalUnit, at least 3 characters

Return Values (Out)

Name	Cardinality	Type	Documentation
result	0..1	Bundle	HVOOrganizationalUnits with at least one business

Can be invoked using a HTTP GET request.

The operation will search recursively down the organizational hierarchy from the given logical id and return all the HVOOrganizationalUnits which have associated instances of HVOBusiness and match the other search parameters. Example:

.../123/$organizational-units-with-business-by-id?name:contains=abc

HVOOrganizationalUnitsWithBusiness

Operation name	HTTP verbs	Link
$hvo-organizational-units-with-business	GET	HVOOrganizationalUnitsWithBusiness