GP Connect - Access Record Structured

Mappings

rim: n/a

Encounter.meta.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.meta.versionId

Short Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Cardinality 0..1

Summary True

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Encounter.meta.lastUpdated

Short When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Cardinality 0..1

instant

Summary True

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

Encounter.meta.profile

Short Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Cardinality 1..*

Summary True

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Encounter.meta.security

Short Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality 0..*

All Security Labels (extensible)

Security Labels from the Healthcare Privacy and Security Classification System.

Summary True

Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Encounter.meta.tag

Short Tags applied to this resource

Definition

Cardinality 0..*

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

Common Tags (example)

Summary True

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Encounter.implicitRules

Short A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Cardinality 0..1

Modifier True

Summary True

Comments

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.

Encounter.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

A human language.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Comments

Encounter.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Narrative

Alias narrative, html, xhtml, display

Comments

Conditions The cardinality or value of this element may be affected by these constraints: dom-1

Mappings

rim: Act.text?

Encounter.contained

Short Contained, inline Resources

Definition

Cardinality 0..*

Resource

Alias inline resources, anonymous resources, contained resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Mappings

rim: N/A

Encounter.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Mappings

rim: N/A

Encounter.extension:encounterTransport

Short Encounter transport

Definition

Encounter transport.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

Encounter.extension:encounterTransport.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.extension:encounterTransport.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportType

Short Additional Content defined by implementations

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportType.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.extension:encounterTransport.extension:transportType.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportType.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

transportType

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportType.value[x]:valueCodeableConcept

Short Transport Type

Definition

Transport Type.

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportPeriod

Short Additional Content defined by implementations

Definition

Cardinality 0..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportPeriod.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.extension:encounterTransport.extension:transportPeriod.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportPeriod.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

transportPeriod

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:transportPeriod.value[x]:valuePeriod

Short Transport Period

Definition

Transport Period.

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:reasonForTransport

Short Additional Content defined by implementations

Definition

Cardinality 0..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:reasonForTransport.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.extension:encounterTransport.extension:reasonForTransport.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:reasonForTransport.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

reasonForTransport

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.extension:reasonForTransport.value[x]:valueString

Short Reason for transport

Definition

Reason for transport.

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:encounterTransport.value[x]

Short Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..0

Type Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:outcomeOfAttendance

Short An extension to the Encounter resource to record the outcome of an Out-Patient attendance.

Definition

Optional Extension Element - found in all resources.

Cardinality 0..1

Type Extension(CodeableConcept)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

Encounter.extension:outcomeOfAttendance.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.extension:outcomeOfAttendance.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:outcomeOfAttendance.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:outcomeOfAttendance.value[x]:valueCodeableConcept

Short This records the outcome of an Out-Patient Attendance Consultant.

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 1..1

NHS Data Model and Dictionary Outcome Of Attendance (required)

This records the outcome of an Out-Patient Attendance Consultant.

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:emergencyCareDischargeStatus

Short An extension to the Encounter resource which is used indicate the status of the Patient on discharge from an Emergency Care Department.

Definition

Optional Extension Element - found in all resources.

Cardinality 0..1

Type Extension(CodeableConcept)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

Encounter.extension:emergencyCareDischargeStatus.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.extension:emergencyCareDischargeStatus.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.extension:emergencyCareDischargeStatus.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

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

Mappings

rim: n/a
rim: N/A

Encounter.extension:emergencyCareDischargeStatus.value[x]:valueCodeableConcept

Short The status of the Patient on discharge from an Emergency Care Department.

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 1..1

Care Connect Emergency Care Discharge Status (required)

The status of the Patient on discharge from an Emergency Care Department.

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Alias extensions, user content

Comments

Mappings

rim: N/A

Encounter.identifier

Short Identifier(s) by which this encounter is known

Definition

Identifier(s) by which this encounter is known.

Cardinality 1..*

Identifier

Summary True

Mappings

v2: PV1-19
rim: .id
w5: id

Encounter.identifier.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.identifier.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.identifier.use

Short usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

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

Comments

Mappings

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

Encounter.identifier.type

Short Description of identifier

Definition

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

Cardinality 0..1

Identifier Type Codes (extensible)

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

Summary True

Requirements

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

Comments

Mappings

v2: CX.5
rim: Role.code or implied by context

Encounter.identifier.system

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 1..1

Summary True

Requirements

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

Examples

General

http://www.acme.com/identifiers/patient

Mappings

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

Encounter.identifier.value

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Summary True

Comments

Examples

General

Mappings

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

Encounter.identifier.period

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Encounter.identifier.assigner

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(CareConnect-Organization-1)

Summary True

Comments

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

Mappings

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

Encounter.status

Definition

Cardinality 1..1

Current state of the encounter

EncounterStatus (required)

Modifier True

Summary True

Comments

Note that internal business rules will detemine the appropraite transitions that may occur between statuses (and also classes).

This element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid.

Mappings

v2: No clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16
rim: .statusCode
w5: status

Encounter.statusHistory

Short List of past encounter statuses

Definition

The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

Cardinality 0..1

Comments

The current status is always found in the current version of the resource, not the status history.

Constraints

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

Mappings

rim: n/a

Encounter.statusHistory.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.statusHistory.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Mappings

rim: n/a

Encounter.statusHistory.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

Mappings

rim: N/A

Encounter.statusHistory.status

Definition

Cardinality 1..1

Current state of the encounter

EncounterStatus (required)

Mappings

rim: n/a

Encounter.statusHistory.period

Short The time that the episode was in the specified status

Definition

The time that the episode was in the specified status.

Cardinality 1..1

Mappings

rim: n/a

Encounter.class

Short inpatient | outpatient | ambulatory | emergency +

Definition

inpatient | outpatient | ambulatory | emergency +.

Cardinality 0..1

Classification of the encounter

ActEncounterCode (extensible)

Summary True

Mappings

v2: PV1-2
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
w5: class

Encounter.classHistory

Short List of past encounter classes

Definition

The class history permits the tracking of the encounters transitions without needing to go through the resource history.

Cardinality 0..*

Constraints

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

Mappings

rim: n/a

Encounter.classHistory.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.classHistory.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Mappings

rim: n/a

Encounter.classHistory.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

Mappings

rim: N/A

Encounter.classHistory.class

Short Classification of the encounter

Definition

Classification of the encounter.

Cardinality 1..1

Classification of the encounter

ActEncounterCode (extensible)

Mappings

rim: n/a

Encounter.classHistory.period

Short The time that the episode was in the specified class

Definition

The time that the episode was in the specified class.

Cardinality 1..1

Mappings

rim: n/a

Encounter.type

Short Specific type of encounter

Definition

Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

Cardinality 1..1

The type of encounter

EncounterType (example)

Summary True

Comments

Since there are many ways to further classify encounters, this element is 0..*.

Mappings

v2: PV1-4 / PV1-18
rim: .code
w5: class

Encounter.type.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.type.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.type.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Summary True

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Unordered, Open, by system(Value)

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Encounter.type.coding:snomedCT

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Care Connect Encounter Type (extensible)

A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record).

Summary True

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Encounter.type.coding:snomedCT.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.type.coding:snomedCT.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID

Short The SNOMED CT Description ID for the display

Definition

The SNOMED CT Description ID for the display.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId

Short The SNOMED CT Description ID

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

descriptionId

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId

Short The SNOMED CT Description ID

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay

Short The SNOMED CT display for the description ID

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

descriptionDisplay

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString

Short The SNOMED CT display for the description ID

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..0

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.type.coding:snomedCT.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Summary True

Requirements

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

Comments

Fixed Value

http://snomed.info/sct

Mappings

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

Encounter.type.coding:snomedCT.version

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Mappings

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

Encounter.type.coding:snomedCT.code

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Mappings

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

Encounter.type.coding:snomedCT.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Summary True

Requirements

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

Mappings

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

Encounter.type.coding:snomedCT.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Cardinality 0..1

boolean

Summary True

Requirements

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.

Comments

Mappings

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 ]

Encounter.type.text

Short Plain text representation of the consultation type as displayed by system

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

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

Mappings

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

Encounter.priority

Short Indicates the urgency of the encounter

Definition

Indicates the urgency of the encounter.

Cardinality 0..1

v3 Code System ActPriority (example)

Indicates the urgency of the encounter.

Mappings

v2: PV2-25
rim: .priorityCode
w5: grade

Encounter.subject

Short Reference to Patient resource representing the Patient against whom the source consultation/encounter was recorded.

Definition

The patient present at the encounter.

Cardinality 1..1

Type Reference(CareConnect-GPC-Patient-1)

Summary True

Alias patient

Comments

Mappings

v2: PID-3
rim: .participation[typeCode=SBJ]/role[classCode=PAT]
w5: who.focus

Encounter.episodeOfCare

Short Episode(s) of care that this encounter should be recorded against

Definition

Cardinality 0..*

Type Reference(EpisodeOfCare)

Summary True

Mappings

v2: PV1-54, PV1-53
rim: n/a
w5: context

Encounter.incomingReferral

Short The ReferralRequest that initiated this encounter

Definition

The referral request this encounter satisfies (incoming referral).

Cardinality 0..*

Type Reference(CareConnect-ReferralRequest-1)

Mappings

rim: .reason.ClinicalDocument

Encounter.participant

Short List of participants involved in the encounter

Definition

The list of people responsible for providing the service.

Cardinality 1..*

Summary True

Constraints

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

Mappings

v2: ROL
rim: .participation[typeCode=PFM]

Encounter.participant.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.participant.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Mappings

rim: n/a

Encounter.participant.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

Mappings

rim: N/A

Encounter.participant.type

Short Role of participant in encounter

Definition

Role of participant in encounter.

Cardinality 0..*

GPConnect Participant Type (extensible)

Role of participant in encounter

Must Support True

Summary True

Comments

Mappings

v2: ROL-3 (or maybe PRT-4)
rim: .functionCode

Encounter.participant.period

Short Period of time during the encounter that the participant participated

Definition

The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

Cardinality 0..1

Mappings

v2: ROL-5, ROL-6 (or maybe PRT-5)
rim: .time

Encounter.participant.individual

Short Persons involved in the encounter other than the patient

Definition

Persons involved in the encounter other than the patient.

Cardinality 1..1

Type Reference(RelatedPerson | CareConnect-GPC-Practitioner-1)

Summary True

Mappings

v2: ROL-4
rim: .role
w5: who

Encounter.appointment

Short The appointment that scheduled this encounter

Definition

The appointment that scheduled this encounter.

Cardinality 0..1

Type Reference(Appointment)

Summary True

Mappings

v2: SCH-1 / SCH-2
rim: .outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]

Encounter.period

Short The start and end time of the encounter

Definition

The start and end time of the encounter.

Cardinality 0..1

Must Support True

Comments

If not (yet) known, the end of the Period may be omitted.

Mappings

v2: PV1-44, PV1-45
rim: .effectiveTime (low & high)
w5: when.done

Encounter.period.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.period.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.period.start

Short Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive. This should be populated with the displayed consultation date and time.

Cardinality 1..1

dateTime

Summary True

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Conditions The cardinality or value of this element may be affected by these constraints: per-1

Mappings

v2: DR.1
rim: ./low

Encounter.period.end

Short End time with inclusive boundary, if not ongoing

Definition

Cardinality 0..1

dateTime

Summary True

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Conditions The cardinality or value of this element may be affected by these constraints: per-1

Mappings

v2: DR.2
rim: ./high

Encounter.length

Short Quantity of time the encounter lasted (less time absent)

Definition

Quantity of time the encounter lasted. This excludes the time during leaves of absence.

Cardinality 0..1

Duration

Comments

May differ from the time the Encounter.period lasted because of leave of absence.

Mappings

v2: (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes
rim: .lengthOfStayQuantity

Encounter.reason

Short Reason the encounter takes place (code)

Definition

Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

Cardinality 0..*

Encounter Reason Codes (preferred)

Reason why the encounter takes place.

Summary True

Alias Indication, Admission diagnosis

Comments

For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

Mappings

v2: EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )
rim: .reasonCode
w5: why

Encounter.reason.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.reason.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.reason.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Summary True

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Unordered, Open, by system(Value)

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Encounter.reason.coding:snomedCT

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Summary True

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Encounter.reason.coding:snomedCT.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.reason.coding:snomedCT.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID

Short The SNOMED CT Description ID for the display

Definition

The SNOMED CT Description ID for the display.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId

Short The SNOMED CT Description ID

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

descriptionId

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId

Short The SNOMED CT Description ID

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay

Short The SNOMED CT display for the description ID

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

descriptionDisplay

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString

Short The SNOMED CT display for the description ID

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..0

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.reason.coding:snomedCT.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Summary True

Requirements

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

Comments

Fixed Value

http://snomed.info/sct

Mappings

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

Encounter.reason.coding:snomedCT.version

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Mappings

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

Encounter.reason.coding:snomedCT.code

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Mappings

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

Encounter.reason.coding:snomedCT.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Summary True

Requirements

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

Mappings

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

Encounter.reason.coding:snomedCT.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Cardinality 0..1

boolean

Summary True

Requirements

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.

Comments

Mappings

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 ]

Encounter.reason.text

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

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

Mappings

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

Encounter.diagnosis

Short The list of diagnosis relevant to this encounter

Definition

The list of diagnosis relevant to this encounter.

Cardinality 0..*

Summary True

Constraints

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

Mappings

rim: .outboundRelationship[typeCode=RSON]

Encounter.diagnosis.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.diagnosis.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Mappings

rim: n/a

Encounter.diagnosis.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

Mappings

rim: N/A

Encounter.diagnosis.condition

Short Reason the encounter takes place (resource)

Definition

Cardinality 1..1

Type Reference(CareConnect-Procedure-1 | CareConnect-Condition-1)

Alias Admission diagnosis, discharge diagnosis, indication

Comments

For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

Mappings

v2: Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively.
rim: .outboundRelationship[typeCode=RSON].target
w5: why

Encounter.diagnosis.role

Short Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)

Definition

Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

Cardinality 0..1

The type of diagnosis this condition represents

DiagnosisRole (preferred)

Mappings

rim: n/a

Encounter.diagnosis.rank

Short Ranking of the diagnosis (for each role type)

Definition

Ranking of the diagnosis (for each role type).

Cardinality 0..1

positiveInt

Mappings

rim: .outboundRelationship[typeCode=RSON].priority

Encounter.account

Short The set of accounts that may be used for billing for this Encounter

Definition

The set of accounts that may be used for billing for this Encounter.

Cardinality 0..*

Type Reference(Account)

Comments

The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.

Mappings

rim: .pertains.A_Account

Encounter.hospitalization

Short Details about the admission to a healthcare service

Definition

Details about the admission to a healthcare service.

Cardinality 0..1

Comments

An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.

The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.

Constraints

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

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]

Encounter.hospitalization.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.hospitalization.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Mappings

rim: n/a

Encounter.hospitalization.extension:admissionMethod

Short An extension to the Encounter resource to record how a Patient was admitted to hospital.

Definition

Optional Extension Element - found in all resources.

Cardinality 0..1

Type Extension(CodeableConcept)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:admissionMethod.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.hospitalization.extension:admissionMethod.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:admissionMethod.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:admissionMethod.value[x]:valueCodeableConcept

Short The method of admission to a Hospital Provider Spell.

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 1..1

NHS Data Model and Dictionary Admission Method (required)

The method of admission to a Hospital Provider Spell.

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:dischargeMethod

Short An extension to the Encounter resource to record the method of discharge from hospital.

Definition

Optional Extension Element - found in all resources.

Cardinality 0..1

Type Extension(CodeableConcept)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:dischargeMethod.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.hospitalization.extension:dischargeMethod.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:dischargeMethod.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.extension:dischargeMethod.value[x]:valueCodeableConcept

Short The method of discharge from a Hospital Provider Spell.

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 1..1

NHS Data Model and Dictionary Discharge Method (required)

The method of discharge from a Hospital Provider Spell.

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

Mappings

rim: N/A

Encounter.hospitalization.preAdmissionIdentifier

Short Pre-admission identifier

Definition

Pre-admission identifier.

Cardinality 0..1

Identifier

Mappings

v2: PV1-5
rim: .id

Encounter.hospitalization.preAdmissionIdentifier.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.hospitalization.preAdmissionIdentifier.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.hospitalization.preAdmissionIdentifier.use

Short usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

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

Comments

Mappings

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

Encounter.hospitalization.preAdmissionIdentifier.type

Short Description of identifier

Definition

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

Cardinality 0..1

Identifier Type Codes (extensible)

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

Summary True

Requirements

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

Comments

Mappings

v2: CX.5
rim: Role.code or implied by context

Encounter.hospitalization.preAdmissionIdentifier.system

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 1..1

Summary True

Requirements

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

Examples

General

http://www.acme.com/identifiers/patient

Mappings

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

Encounter.hospitalization.preAdmissionIdentifier.value

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Summary True

Comments

Examples

General

Mappings

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

Encounter.hospitalization.preAdmissionIdentifier.period

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Encounter.hospitalization.preAdmissionIdentifier.assigner

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(CareConnect-Organization-1)

Summary True

Comments

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

Mappings

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

Encounter.hospitalization.origin

Short The location from which the patient came before admission

Definition

The location from which the patient came before admission.

Cardinality 0..1

Type Reference(CareConnect-Location-1)

Mappings

rim: .participation[typeCode=ORG].role

Encounter.hospitalization.admitSource

Short From where patient was admitted (physician referral, transfer)

Definition

From where patient was admitted (physician referral, transfer).

Cardinality 0..1

NHS Data Model and Dictionary Source Of Admission (preferred)

The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home.

Mappings

v2: PV1-14
rim: .admissionReferralSourceCode

Encounter.hospitalization.reAdmission

Short The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission

Definition

Whether this hospitalization is a readmission and why if known.

Cardinality 0..1

v2 Re-Admission Indicator (example)

The reason for re-admission of this hospitalization encounter.

Mappings

v2: PV1-13
rim: n/a

Encounter.hospitalization.reAdmission.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Summary True

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Unordered, Open, by system(Value)

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Encounter.hospitalization.reAdmission.coding:snomedCT

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Summary True

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Encounter.hospitalization.reAdmission.coding:snomedCT.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.coding:snomedCT.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID

Short The SNOMED CT Description ID for the display

Definition

The SNOMED CT Description ID for the display.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId

Short The SNOMED CT Description ID

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

descriptionId

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId

Short The SNOMED CT Description ID

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay

Short The SNOMED CT display for the description ID

Definition

Cardinality 1..1

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

descriptionDisplay

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString

Short The SNOMED CT display for the description ID

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..1

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Cardinality 0..0

Comments

A stream of bytes, base64 encoded

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Encounter.hospitalization.reAdmission.coding:snomedCT.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Summary True

Requirements

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

Comments

Fixed Value

http://snomed.info/sct

Mappings

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

Encounter.hospitalization.reAdmission.coding:snomedCT.version

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Mappings

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

Encounter.hospitalization.reAdmission.coding:snomedCT.code

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Mappings

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

Encounter.hospitalization.reAdmission.coding:snomedCT.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Summary True

Requirements

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

Mappings

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

Encounter.hospitalization.reAdmission.coding:snomedCT.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Cardinality 0..1

boolean

Summary True

Requirements

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.

Comments

Mappings

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 ]

Encounter.hospitalization.reAdmission.text

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

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

Mappings

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

Encounter.hospitalization.dietPreference

Short Diet preferences reported by the patient

Definition

Diet preferences reported by the patient.

Cardinality 0..*

Medical, cultural or ethical food preferences to help with catering requirements.

Diet (extensible)

Requirements

Comments

For example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).

Mappings

v2: PV1-38
rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]

Encounter.hospitalization.specialCourtesy

Short Special courtesies (VIP, board member)

Definition

Special courtesies (VIP, board member).

Cardinality 0..*

Special courtesies

SpecialCourtesy (preferred)

Mappings

v2: PV1-16
rim: .specialCourtesiesCode

Encounter.hospitalization.specialArrangement

Short Wheelchair, translator, stretcher, etc.

Definition

Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

Cardinality 0..*

SpecialArrangements (preferred)

Special arrangements

Mappings

v2: PV1-15 / OBR-30 / OBR-43
rim: .specialArrangementCode

Encounter.hospitalization.destination

Short Location to which the patient is discharged

Definition

Location to which the patient is discharged.

Cardinality 0..1

Type Reference(CareConnect-Location-1)

Mappings

v2: PV1-37
rim: .participation[typeCode=DST]

Encounter.hospitalization.dischargeDisposition

Short Category or kind of location after discharge

Definition

Category or kind of location after discharge.

Cardinality 0..1

NHS Data Model and Dictionary Discharge Destination (example)

The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth.

Mappings

v2: PV1-36
rim: .dischargeDispositionCode

Encounter.location

Short List of locations where the patient has been

Definition

List of locations where the patient has been during this encounter.

Cardinality 0..*

Comments

Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

Constraints

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

Mappings

rim: .participation[typeCode=LOC]

Encounter.location.id

Short xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Encounter.location.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Mappings

rim: n/a

Encounter.location.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

Mappings

rim: N/A

Encounter.location.location

Short Location the encounter takes place

Definition

The location where the encounter takes place.

Cardinality 1..1

Type Reference(CareConnect-Location-1)

Mappings

v2: PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43
rim: .role
w5: where

Encounter.location.status

Short planned | active | reserved | completed

Definition

The status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.

Cardinality 0..1

EncounterLocationStatus (required)

The status of the location.

Comments

When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.

Mappings

rim: .role.statusCode

Encounter.location.period

Short Time period during which the patient was present at the location

Definition

Time period during which the patient was present at the location.

Cardinality 0..1