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

• rim: Entity. Role, or Act
• rim: role

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

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

• rim: n/a

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() or (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 information is added later.

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

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

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.

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

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

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

• 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: NK1-33
• rim: .id

Need to be able to mark a related person record as not to be used, such as if it was created in error.

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() or (children().count() > id.count())

• rim: n/a
• w5: FiveWs.status
• rim: .statusCode

We need to know which patient this RelatedPerson is related to.

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

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• v2: PID-3
• rim: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• w5: FiveWs.class
• v2: NK1-3
• rim: code

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

Allows for alternative encodings within a code system, and translations to other code systems.

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

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

• rim: n/a
• v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
• rim: CV
• orim: fhir:Coding rdfs:subClassOf dt:CDCoding
• v2: C*E.1-8, C*E.10-22
• rim: union(., ./translation)
• orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

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

Need to be unambiguous about the source of the definition of the symbol.

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

• rim: n/a
• v2: C*E.3
• rim: ./codeSystem
• orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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

• rim: n/a
• v2: C*E.7
• rim: ./codeSystemVersion
• orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Need to refer to a particular code in the system.

Note that FHIR strings SHALL NOT exceed 1MB in size

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

• rim: n/a
• v2: C*E.1
• rim: ./code
• orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Note that FHIR strings SHALL NOT exceed 1MB in size

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

• rim: n/a
• v2: C*E.2 - but note this is not well followed
• rim: CV.displayName
• orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

• rim: n/a
• v2: Sometimes implied by being first
• rim: CD.codingRationale
• orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Very often the text is the same as a displayName of one of the codings.

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

• rim: n/a
• v2: C*E.9. But note many systems use C*E.2 for this
• rim: ./originalText[mediaType/code="text/plain"]/data
• orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

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.

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

• rim: n/a
• v2: XPN
• rim: EN (actually, PN)
• servd: ProviderName
• v2: NK1-2
• rim: name

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

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

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() or (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 parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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() or (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 parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

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

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

Note that FHIR strings SHALL NOT exceed 1MB in size

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

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

Note that FHIR strings SHALL NOT exceed 1MB in size

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

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

Allows names to be placed in historical context.

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.

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

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

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

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

• rim: n/a
• v2: XTN
• rim: TEL
• servd: ContactPoint
• v2: NK1-5 / NK1-6 / NK1-40
• rim: telecom

Needed for identification of the person, in combination with (at least) name and birth date.

Note that FHIR strings SHALL NOT exceed 1MB in size

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

• rim: n/a
• v2: NK1-15
• rim: administrativeGender

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

• rim: n/a
• rim: player.birthTime

Need to keep track where the related person can be contacted per postal mail or visited.

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

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

• rim: n/a
• v2: XAD
• rim: AD
• servd: Address
• v2: NK1-4
• rim: addr

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (children().count() > id.count())
• att-1: If the Attachment has data, it SHALL have a contentType
  data.empty() or contentType.exists()

• rim: n/a
• v2: ED/RP
• rim: ED
• v2: OBX-5 - needs a profile
• rim: player[classCode='PSN' and determinerCode='INSTANCE']/desc

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.

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

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• w5: FiveWs.done[x]
• rim: .effectiveTime

If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

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

• rim: n/a
• rim: LanguageCommunication

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

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.

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

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

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

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

This language is specifically identified for communicating healthcare information.

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

• rim: n/a
• rim: preferenceInd