GP Connect Send Document

• 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

• rim:Entity. Role, or Act
• v2:(also see master files messages)
• rim:Organization(classCode=ORG, determinerCode=INST)
• servd:Organization
• w5:administrative.group

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

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

• rim:n/a

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

• rim:n/a
• rim:N/A

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.

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

• rim:n/a

A human language.

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

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

• rim:n/a

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.

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

• rim:n/a
• rim:N/A
• rim:Act.text?

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.

• rim:Entity. Role, or Act
• rim:N/A

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.

• 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()

• rim:n/a
• rim:N/A

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.

• 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()

• rim:n/a
• rim:N/A

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

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.

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

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1

• rim:n/a
• rim:N/A

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

• rim:n/a
• rim:N/A

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.

• 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()

• rim:n/a
• rim:N/A

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.

• 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()

• rim:n/a
• rim:N/A

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

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

• 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

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

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

• 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

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

Identifies the purpose for this identifier, if known .

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

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.

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

• rim:n/a
• v2:N/A
• rim:Role.code or implied by context

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

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

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.

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

• 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

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.

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

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

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

• rim:n/a
• v2:CX.4 / EI-2-4
• rim:II.root or Role.id.root
• servd:./IdentifierType

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.

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

• 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

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.

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

• 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

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.

• 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'))

• 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

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

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

• 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

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

Identifies the purpose for this identifier, if known .

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

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.

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

• rim:n/a
• v2:N/A
• rim:Role.code or implied by context

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

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

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.

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

• 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

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.

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

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

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

• rim:n/a
• v2:CX.4 / EI-2-4
• rim:II.root or Role.id.root
• servd:./IdentifierType

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.

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

• 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

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.

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

• 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

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.

• 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'))

• 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

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

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.

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

• 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

Used to categorize the organization

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

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.

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

• 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

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

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.

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

• rim:n/a
• v2:XON.1
• rim:.name
• servd:.PreferredName/Name

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.

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.

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

• rim:n/a
• rim:.name

Human contact for the organization.

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.

• 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()

• rim:n/a
• v2:XTN
• rim:TEL
• servd:ContactPoint
• v2:ORC-22?
• rim:.telecom
• servd:./ContactPoints

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.

• 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()

• rim:n/a
• v2:XAD
• rim:AD
• servd:Address
• v2:ORC-23?
• rim:.address
• servd:./PrimaryAddress and ./OtherAddresses

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

The use of an address

Allows an appropriate address to be chosen from a list of many.

This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

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

• rim:n/a
• v2:XAD.7
• rim:unique(./use)
• servd:./AddressPurpose

The type of an address (physical / postal)

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.18
• rim:unique(./use)
• vcard:address type parameter

A renderable, unencoded form.

Can provide both a text representation and parts.

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

• rim:n/a
• v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
• rim:./formatted
• vcard:address label parameter

home | work | temp | old - purpose of this address.

Note that FHIR strings may not exceed 1MB in size

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

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

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.3
• rim:AD.part[parttype = CTY]
• vcard:locality
• servd:./Jurisdiction

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.

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

• rim:n/a
• v2:XAD.9
• rim:AD.part[parttype = CNT | CPA]

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.4
• rim:AD.part[parttype = STA]
• vcard:region
• servd:./Region

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.5
• rim:AD.part[parttype = ZIP]
• vcard:code
• servd:./PostalIdentificationCode

ISO 3166 3 letter codes can be used in place of a full country name.

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

• rim:n/a
• v2:XAD.6
• rim:AD.part[parttype = CNT]
• vcard:country
• servd:./Country

Allows addresses to be placed in historical context.

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.

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

• 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

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

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.

• 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'))

• 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

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

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.

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

• rim:n/a
• rim:.contactParty

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

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.

• 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()

• rim:n/a
• rim:N/A

The purpose for which you would contact a contact party

Need to distinguish between multiple contact persons.

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.

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

• rim:n/a
• v2:CE/CNE/CWE
• rim:CD
• orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
• rim:./type

Need to be able to track the person by name.

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.

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

• rim:n/a
• v2:XPN
• rim:EN (actually, PN)
• servd:ProviderName
• v2:PID-5, PID-9
• rim:./name

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

The use of a human name

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

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.

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

• rim:n/a
• v2:XPN.7, but often indicated by which field contains the name
• rim:unique(./use)
• servd:./NamePurpose

A renderable, unencoded form.

Can provide both a text representation and structured parts.

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

• rim:n/a
• v2:implied by XPN.11
• rim:./formatted

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

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

• rim:n/a
• v2:XPN.1/FN.1
• rim:./part[partType = FAM]
• servd:./FamilyName

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.

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

• rim:n/a
• v2:XPN.2 + XPN.3
• rim:./part[partType = GIV]
• servd:./GivenNames

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XPN.5
• rim:./part[partType = PFX]
• servd:./TitleCode

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XPN/4
• rim:./part[partType = SFX]

Allows names to be placed in historical context.

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.

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

• 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

People have (primary) ways to contact them in some way such as phone, email.

• 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()

• rim:n/a
• v2:XTN
• rim:TEL
• servd:ContactPoint
• v2:PID-13, PID-14
• rim:./telecom

May need to keep track of a contact party's address for contacting, billing or reporting requirements.

Note: address is for postal addresses, not physical locations.

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

• rim:n/a
• v2:XAD
• rim:AD
• servd:Address
• v2:PID-11
• rim:./addr

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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.

• 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()

• rim:n/a
• rim:N/A

The use of an address

Allows an appropriate address to be chosen from a list of many.

This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

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

• rim:n/a
• v2:XAD.7
• rim:unique(./use)
• servd:./AddressPurpose

The type of an address (physical / postal)

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.18
• rim:unique(./use)
• vcard:address type parameter

A renderable, unencoded form.

Can provide both a text representation and parts.

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

• rim:n/a
• v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
• rim:./formatted
• vcard:address label parameter

home | work | temp | old - purpose of this address.

Note that FHIR strings may not exceed 1MB in size

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

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

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.3
• rim:AD.part[parttype = CTY]
• vcard:locality
• servd:./Jurisdiction

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.

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

• rim:n/a
• v2:XAD.9
• rim:AD.part[parttype = CNT | CPA]

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.4
• rim:AD.part[parttype = STA]
• vcard:region
• servd:./Region

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:XAD.5
• rim:AD.part[parttype = ZIP]
• vcard:code
• servd:./PostalIdentificationCode

ISO 3166 3 letter codes can be used in place of a full country name.

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

• rim:n/a
• v2:XAD.6
• rim:AD.part[parttype = CNT]
• vcard:country
• servd:./Country

Allows addresses to be placed in historical context.

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.

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

• 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

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.

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.

• 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'))

• rim:n/a
• rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)