Organization

Defines the ID Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information.

Usage

This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

URL

Type URL
Canonical https://fhir.kemkes.go.id/r4/StructureDefinition/Organization

Structure

Snapshot

identifierΣ I0..*Identifier
activeΣ ?!0..1boolean
typeΣ0..*CodeableConcept
nameΣ I0..1string
alias0..*string
telecomI0..*ContactPoint
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
valueCodecode
url1..1System.StringFixed Value
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(Organization)
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
endpointI0..*Reference(Endpoint)

Examples

Dictionary

Organization
DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
Cardinality0...*
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
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
TypeSystem.String
SummaryTrue
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
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
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
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of 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
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
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
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have 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
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim:Entity. Role, or Act
  • rim:N/A
Organization.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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
DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

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

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.active
DefinitionWhether the organization's record is still in active use.
Cardinality0...1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

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

Comments

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

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

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
DefinitionThe kind(s) of organization that this is.
Cardinality0...*
TypeCodeableConcept
Binding

Used to categorize the organization.

OrganizationType (example)
SummaryTrue
Requirements

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

Comments

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

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

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

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.name
DefinitionA name associated with the organization.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XON.1
  • rim:.name
  • servd:.PreferredName/Name
Organization.alias
DefinitionA list of alternate names that the organization is known as, or was known as in the past.
Cardinality0...*
Typestring
Requirements

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

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

Comments

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

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.name
Organization.telecom
DefinitionA contact detail for the organization.
Cardinality0...*
TypeContactPoint
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
DefinitionAn address for the organization.
Cardinality0...*
TypeAddress
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.address.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode
DefinitionThe regional administrative code of the address, represented in six levels: province, city/regency, district, village, rt and rw.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension
DefinitionMay 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.
Cardinality2...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:rt
DefinitionMay 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.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.extension:rt.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension:rt.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:rt.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

rt

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.extension:rt.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
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.address.extension:administrativeCode.extension:rw
DefinitionMay 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.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.extension:rw.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension:rw.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:rw.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

rw

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.extension:rw.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
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.address.extension:administrativeCode.extension:village
DefinitionMay 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.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.extension:village.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension:village.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:village.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

village

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.extension:village.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
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.address.extension:administrativeCode.extension:district
DefinitionMay 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.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.extension:district.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension:district.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:district.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

district

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.extension:district.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
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.address.extension:administrativeCode.extension:city
DefinitionMay 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.
Cardinality1...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.extension:city.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension:city.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:city.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

city

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.extension:city.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
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.address.extension:administrativeCode.extension:province
DefinitionMay 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.
Cardinality1...1
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.address.extension:administrativeCode.extension:province.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.address.extension:administrativeCode.extension:province.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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.address.extension:administrativeCode.extension:province.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

province

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.extension:province.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
Typecode
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.address.extension:administrativeCode.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
TypeSystem.String
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

https://fhir.kemkes.go.id/r4/StructureDefinition/AdministrativeCode

Mappings
  • rim:N/A
Organization.address.extension:administrativeCode.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
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.address.use
DefinitionThe purpose of this address.
Cardinality0...1
Typecode
Binding

The use of an address.

AddressUse (required)
ModifierTrue
SummaryTrue
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.address.type
DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Cardinality0...1
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)
SummaryTrue
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.address.text
DefinitionSpecifies 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.
Cardinality0...1
Typestring
SummaryTrue
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.address.line
DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Cardinality0...*
Typestring
SummaryTrue
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

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.address.city
DefinitionThe name of the city, town, suburb, village or other community or delivery center.
Cardinality0...1
Typestring
SummaryTrue
AliasMunicpality
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

Erewhon


Mappings
  • rim:n/a
  • v2:XAD.3
  • rim:AD.part[parttype = CTY]
  • vcard:locality
  • servd:./Jurisdiction
Organization.address.district
DefinitionThe name of the administrative area (county).
Cardinality0...1
Typestring
SummaryTrue
AliasCounty
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.address.state
DefinitionSub-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).
Cardinality0...1
Typestring
SummaryTrue
AliasProvince, 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.address.postalCode
DefinitionA postal code designating a region defined by the postal service.
Cardinality0...1
Typestring
SummaryTrue
AliasZip
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.address.country
DefinitionCountry - a nation as commonly understood or generally accepted.
Cardinality0...1
Typestring
SummaryTrue
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.address.period
DefinitionTime period when address was/is in use.
Cardinality0...1
TypePeriod
SummaryTrue
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.partOf
DefinitionThe organization of which this organization forms a part.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be 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
DefinitionContact for the organization for a certain purpose.
Cardinality0...*
TypeBackboneElement
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
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
Organization.contact.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, 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
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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
DefinitionIndicates a purpose for which the contact can be reached.
Cardinality0...1
TypeCodeableConcept
Binding

The purpose for which you would contact a contact party.

ContactEntityType (extensible)
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
DefinitionA name associated with the contact.
Cardinality0...1
TypeHumanName
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
DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Cardinality0...*
TypeContactPoint
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()
Mappings
  • rim:n/a
  • v2:XTN
  • rim:TEL
  • servd:ContactPoint
  • v2:PID-13, PID-14
  • rim:./telecom
Organization.contact.address
DefinitionVisiting or postal addresses for the contact.
Cardinality0...1
TypeAddress
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.endpoint
DefinitionTechnical endpoints providing access to services operated for the organization.
Cardinality0...*
TypeReference(Endpoint)
Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be 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)