GP Connect - Update Record (ITK3)

Part of the GP Connect product family

Profile: CareConnect-GPC-Organization-1

mainLocationI0..1Extension(Reference(CareConnect-GPC-Location-1))
organization-periodI0..1Extension(Period)
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
activeΣ ?!0..1boolean
typeΣ0..1CodeableConceptBinding
nameΣ I1..1string
alias0..*string
telecomS I0..*ContactPoint
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..0string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
partOfΣ I0..1Reference(CareConnect-GPC-Organization-1)
purpose0..1CodeableConceptBinding
useΣ ?!0..1codeBinding
textΣ0..1string
familyΣ1..1string
givenΣ0..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
telecomI0..*ContactPoint
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..0string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
endpointI0..*Reference(Endpoint)
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, etc.
Cardinality0...*
Invariants
  • dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
    contained.text.empty()
  • dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    contained.where(('#'+id in %resource.descendants().reference).not()).empty()
  • org-1:The organization SHALL at least have a name or an id, 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
  • w5:administrative.group
Organization.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Organization.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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.
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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.

Common Languages (extensible)
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() | (children().count() > id.count())
Mappings
  • rim:n/a
Organization.text
DefinitionA human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
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 in formation is added later.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
  • rim:Act.text?
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.

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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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() | (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:mainLocation
DefinitionThe main location of the organization.
Cardinality0...1
TypeExtension(Reference(CareConnect-Location-1))
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() | (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:organization-period
DefinitionThe date range that this organization should be considered available.
Cardinality0...1
TypeExtension(Period)
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() | (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:organization-period.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
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Organization.extension:organization-period.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...0
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() | (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:organization-period.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Fixed Value

http://hl7.org/fhir/StructureDefinition/organization-period

Mappings
  • rim:n/a
  • rim:N/A
Organization.extension:organization-period.valuePeriod:valuePeriod
DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality0...1
TypePeriod
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
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() | (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.

SlicingUnordered, Open At End, by system(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd:Identifier
  • v2:XON.10 / XON.3
  • rim:.scopes[Role](classCode=IDENT)
  • servd:./Identifiers
  • w5:id
Organization.identifier:odsOrganisationCode
DefinitionIdentifier code supplier by the Organisation Data Service
Cardinality0...1
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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd:Identifier
  • v2:XON.10 / XON.3
  • rim:.scopes[Role](classCode=IDENT)
  • servd:./Identifiers
  • w5:id
Organization.identifier:odsOrganisationCode.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
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Organization.identifier:odsOrganisationCode.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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() | (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:odsOrganisationCode.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. 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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:N/A
  • rim:Role.code or implied by context
Organization.identifier:odsOrganisationCode.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)
SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:CX.5
  • rim:Role.code or implied by context
Organization.identifier:odsOrganisationCode.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

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

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Fixed Value

https://fhir.nhs.uk/Id/ods-organization-code

Mappings
  • rim:n/a
  • v2:CX.4 / EI-2-4
  • rim:II.root or Role.id.root
  • servd:./IdentifierType
Organization.identifier:odsOrganisationCode.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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:odsOrganisationCode.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.empty() or end.empty() 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:odsOrganisationCode.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(CareConnect-Organization-1)
SummaryTrue
Comments

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

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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 %resource.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:odsSiteCode
DefinitionODS Site code to identify the organisation at site level
Cardinality0...1
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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd:Identifier
  • v2:XON.10 / XON.3
  • rim:.scopes[Role](classCode=IDENT)
  • servd:./Identifiers
  • w5:id
Organization.identifier:odsSiteCode.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
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Organization.identifier:odsSiteCode.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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() | (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:odsSiteCode.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. 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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:N/A
  • rim:Role.code or implied by context
Organization.identifier:odsSiteCode.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)
SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:CX.5
  • rim:Role.code or implied by context
Organization.identifier:odsSiteCode.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

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

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Fixed Value

https://fhir.nhs.uk/Id/ods-site-code

Mappings
  • rim:n/a
  • v2:CX.4 / EI-2-4
  • rim:II.root or Role.id.root
  • servd:./IdentifierType
Organization.identifier:odsSiteCode.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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:odsSiteCode.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.empty() or end.empty() 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:odsSiteCode.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(CareConnect-Organization-1)
SummaryTrue
Comments

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

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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 %resource.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
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

Default is true.

This active flag is not intended to be used to mark an organizations 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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • 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.
  • w5:status
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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:No equivalent in v2
  • rim:.code
  • servd:n/a
  • w5:class
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() | (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() | (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() | (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() | (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
DefinitionThe organization of which this organization forms a part.
Cardinality0...1
TypeReference(CareConnect-Organization-1)
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() | (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 %resource.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() | (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
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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() | (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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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() | (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() | (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 may or may 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() | (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.name.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
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Organization.contact.name.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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() | (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.name.use
DefinitionIdentifies the purpose for this name.
Cardinality0...1
Typecode
Binding

The use of a human name

NameUse (required)
ModifierTrue
SummaryTrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name 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() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.7, but often indicated by which field contains the name
  • rim:unique(./use)
  • servd:./NamePurpose
Organization.contact.name.text
DefinitionA full text representation of the name.
Cardinality0...1
Typestring
SummaryTrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:implied by XPN.11
  • rim:./formatted
Organization.contact.name.family
DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Cardinality1...1
Typestring
SummaryTrue
Aliassurname
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.1/FN.1
  • rim:./part[partType = FAM]
  • servd:./FamilyName
Organization.contact.name.given
DefinitionGiven name.
Cardinality0...*
Typestring
SummaryTrue
Aliasfirst name, middle name
Comments

If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.2 + XPN.3
  • rim:./part[partType = GIV]
  • servd:./GivenNames
Organization.contact.name.prefix
DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Cardinality0...*
Typestring
SummaryTrue
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN.5
  • rim:./part[partType = PFX]
  • servd:./TitleCode
Organization.contact.name.suffix
DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Cardinality0...*
Typestring
SummaryTrue
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XPN/4
  • rim:./part[partType = SFX]
Organization.contact.name.period
DefinitionIndicates the period of time when this name was valid for the named person.
Cardinality0...1
TypePeriod
SummaryTrue
Requirements

Allows names to be placed in historical context.

Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.empty() or end.empty() 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:XPN.13 + XPN.14
  • rim:./usablePeriod[type="IVL<TS>"]
  • servd:./StartDate and ./EndDate
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() | (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 for postal addresses, not physical locations.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (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() | (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 %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)

back to top