Viktor Test Implementation Guide

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

• rim:Entity. Role, or Act
• rim:Patient[classCode=PAT]
• cda:ClinicalDocument.recordTarget.patientRole
• w5:administrative.individual

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

http://hl7.org/fhir/StructureDefinition/birthPlace

• 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

Patients are almost always assigned specific numerical identifiers.

• 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:PID-3
• rim:id
• cda:.id
• w5:id

Patients are almost always assigned specific numerical identifiers.

• 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:PID-3
• rim:id
• cda:.id
• 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())

urn:oid:1.2.752.129.2.1.3.1

• 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

Patients are almost always assigned specific numerical identifiers.

• 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:PID-3
• rim:id
• cda:.id
• 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())

urn:oid:1.2.752.129.2.1.2.1

• 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 to be able to mark a patient record as not to be used because it was created in error.

Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient

This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.

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

• rim:n/a
• rim:statusCode
• cda:n/a
• w5:status

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

• 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
• cda:.patient.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.

A Patient 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. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

• 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, PID-40
• rim:telecom
• cda:.telecom

The gender of a person used for administrative purposes.

Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.

The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.

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

• rim:n/a
• v2:PID-8
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
• cda:.patient.administrativeGenderCode

Age of the individual drives many clinical processes.

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).

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

• rim:n/a
• v2:PID-7
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
• cda:.patient.birthTime
• loinc:21112-8

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

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

• rim:n/a
• v2:PID-30 (bool) and PID-29 (datetime)
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
• cda:n/a

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Patient may have multiple addresses with different uses or applicable periods.

• ele-1:All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• VJ-1:If the patient has a temporary address, the period this address is in use should be filled in
  (use='temp') implies period.exists()

• rim:n/a
• v2:XAD
• rim:AD
• servd:Address
• v2:PID-11
• rim:addr
• cda:.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

The domestic partnership status of a person.

Most, if not all systems capture it.

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
• v2:PID-16
• rim:player[classCode=PSN]/maritalStatusCode
• cda:.patient.maritalStatusCode

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).

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

• rim:n/a
• v2:PID-24 (bool), PID-25 (integer)
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
• cda:n/a

Many EHR systems have the capability to capture an image of the patient. 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 "Attachment".

• ele-1:All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• att-1:It 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|ANM and determinerCode=INSTANCE]/desc
• cda:n/a

Need to track people you can contact about the patient.

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

• ele-1:All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• pat-1:SHALL at least contain a contact's details or a reference to an organization
  name.exists() or telecom.exists() or address.exists() or organization.exists()

• rim:n/a
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
• cda: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

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 nature of the relationship between a patient and a contact person for that patient.

Used to determine which contact person is the most relevant to approach, depending on circumstances.

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
• v2:NK1-7, NK1-3
• rim:code
• cda:n/a

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact 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 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:NK1-2
• rim:name
• cda:n/a

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

Contact 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() | (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
• cda:n/a

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

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:NK1-4
• rim:addr
• cda:n/a

The gender of a person used for administrative purposes.

Needed to address the person correctly.

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:NK1-15
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
• cda:n/a

For guardians or business related contacts, the organization is relevant.

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:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
• rim:scoper
• cda:n/a

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"]
• rim:effectiveTime
• cda:n/a

Many clinical systems are extended to care for animal patients as well as human.

The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

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

• rim:n/a
• rim:player[classCode=ANM]
• cda: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

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 species of an animal.

Need to know what kind of animal.

If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

• 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:PID-35
• rim:code
• cda:n/a

The breed of an animal.

May need to know the specific kind within the species.

Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production 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:PID-37
• rim:playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code
• cda:n/a

The state of the animal's reproductive organs.

Gender status can affect housing and animal behavior.

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
• v2:N/A
• rim:genderStatusCode
• cda:n/a

If a patient 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 Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient 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() | (children().count() > id.count())

• rim:n/a
• rim:LanguageCommunication
• cda:patient.languageCommunication

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

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

http://inera.se/fhir/dstu3/StructureDefinition/CommunicationMedium

• 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

A human language.

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

• rim:n/a
• v2:CE/CNE/CWE
• rim:CD
• orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2:PID-15, LAN-2
• rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
• cda:.languageCode

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

• rim:n/a
• v2:PID-15
• rim:preferenceInd
• cda:.preferenceInd

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles.

It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.

• 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:PD1-4
• rim:subjectOf.CareEvent.performer.AssignedEntity
• cda:n/a

Need to know who recognizes this patient record, manages and updates it.

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

• 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)
• rim:scoper
• cda:.providerOrganization

There are multiple usecases:

• Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.

There is no assumption that linked patient records have mutual links.

This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.

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

• rim:n/a
• rim:outboundLink
• cda: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

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

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

• 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:PID-3, MRG-1
• rim:id
• cda:n/a

The type of link between this patient resource and another patient resource.

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
• rim:typeCode
• cda:n/a