Sending a prescription

A prescription is a resource of type Bundle containing a CarePlan for the prescription and several MedicationRequest as prescription lines. Additional resources may be added in the Bundle to provide more information.

A full example can be found here.

The prescription Bundle

The prescriber's software creates a transaction Bundle:

EPMedPrescriptionBundle (Bundle)

Bundle

Element id

Bundle

Short description

Contains a collection of resources

Definition

A container for a collection of resources.

Data type

Bundle

Conditions

The cardinality or value of this element may be affected by these constraints: val-SamePatientMedPres, val-SamePSMedPresc

Constraints

bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-12: A message must have a MessageHeader as the first resource
type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history')
bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset')
bdl-11: A document must have a Composition as the first resource
type = 'document' implies entry.first().resource.is(Composition)
bdl-10: A document must have a date
type = 'document' implies (timestamp.hasValue())
bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
val-SamePSMedPresc: Health professional SHALL be the same
Bundle.entry.resource.ofType(MedicationRequest).requester.reference.union(Bundle.entry.resource.ofType(CarePlan).author.reference).union(Bundle.entry.resource.ofType(DocumentReference).author.reference).count()=1
val-SamePatientMedPres: Patient SHALL be the same
Bundle.entry.resource.ofType(MedicationRequest).subject.reference.union(Bundle.entry.resource.ofType(CarePlan).subject.reference).union(Bundle.entry.resource.ofType(DocumentReference).subject.reference).count()=1

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Is assigned by the server, do not provide a value.

Comments

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

Data type

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

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

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

Mappings

rim: n/a
rim: N/A

0..0

string

There are no (further) constraints on this element

Element id

Bundle.meta.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

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

versionId

0..0

There are no (further) constraints on this element

Element id

Bundle.meta.versionId

Short description

Version specific identifier

Definition

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

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.

Data type

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

Mappings

rim: n/a

lastUpdated

0..0

instant

There are no (further) constraints on this element

Element id

Bundle.meta.lastUpdated

Short description

When the resource version last changed

Definition

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

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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

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

Mappings

rim: n/a

source

0..0

uri

There are no (further) constraints on this element

Element id

Bundle.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

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

Mappings

rim: n/a

profile

1..1

canonical(StructureDefinition)Fixed Value

Element id

Bundle.meta.profile

Short description

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.

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.

Data type

canonical(StructureDefinition)

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

Fixed value

https://www.esante.lu/fhir-spec/StructureDefinition/EPMedPrescriptionBundle

Mappings

rim: n/a

security

0..0

CodingBinding

There are no (further) constraints on this element

Element id

Bundle.meta.security

Short description

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.

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.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..0

Coding

There are no (further) constraints on this element

Element id

Bundle.meta.tag

Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

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.

Data type

Coding

Binding

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

CommonTags (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

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

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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

Mappings

rim: n/a

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Comments

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

Data type

Identifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
cda: ClinicalDocument.id

type

1..1

codeBindingFixed Value

Element id

Bundle.type

Short description

Definition

Constant

Comments

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Data type

code

Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)

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

Fixed value

transaction

Mappings

rim: n/a
w5: FiveWs.class

timestamp

0..0

instant

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Comments

For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

Data type

instant

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

Mappings

rim: n/a
w5: FiveWs.init
cda: ClinicalDocument.effectiveTime

total

Σ C

0..0

unsignedInt

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Data type

unsignedInt

Conditions

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

Constraints

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

Mappings

rim: n/a

link

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

Comments

Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

Data type

BackboneElement

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

Mappings

rim: n/a

entry

Σ C

2..*

BackboneElement

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

BackboneElement

Slicing

Unordered, Closed, by resource.meta.profile(Value)

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() or (children().count() > id.count())
bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()

Mappings

rim: n/a

(All Slices)

The requirements in this element apply to all slices

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Extension

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrl

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
Results from operations might involve resources that are not identified.

Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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

Mappings

rim: n/a

resource

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Resource

Mappings

rim: Entity. Role, or Act

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.search.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Data type

code

Binding

Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

SearchEntryMode (required)

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

Mappings

rim: n/a

score

0..1

decimal

There are no (further) constraints on this element

Element id

Bundle.entry.search.score

Short description

Search ranking (between 0 and 1)

Definition

When searching, the server's search ranking score for the entry.

Comments

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

Data type

decimal

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

Mappings

rim: n/a

request

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry.request.method

Short description

Definition

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.

HTTPVerb (required)

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

Mappings

rim: n/a

url

1..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.request.url

Short description

URL for HTTP equivalent of this entry

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

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

Mappings

rim: n/a

ifNoneMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifModifiedSince

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Data type

instant

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

Mappings

rim: n/a

ifMatch

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifMatch

Short description

For managing update contention

Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifNoneExist

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.request.ifNoneExist

Short description

For conditional creates

Definition

Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

response

Σ C

0..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

status

1..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

location

0..1

uri

There are no (further) constraints on this element

Element id

Bundle.entry.response.location

Short description

The location (if the operation returns a location)

Definition

The location header created by processing this operation, populated if the operation returns a location.

Comments

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

Data type

uri

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

Mappings

rim: n/a

etag

0..1

string

There are no (further) constraints on this element

Element id

Bundle.entry.response.etag

Short description

The Etag for the resource (if relevant)

Definition

The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Data type

string

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

Mappings

rim: n/a

lastModified

0..1

instant

There are no (further) constraints on this element

Element id

Bundle.entry.response.lastModified

Short description

Server's date time modified

Definition

The date/time that the resource was modified on the server.

Comments

This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

Data type

instant

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

Mappings

rim: n/a

outcome

0..1

Resource

There are no (further) constraints on this element

Element id

Bundle.entry.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

Data type

Resource

Mappings

rim: Entity. Role, or Act

prescription

Σ C

1..1

BackboneElement

Element id

Bundle.entry:prescription

Short description

The prescription

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

BackboneElement

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() or (children().count() > id.count())
bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

link

0..0

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrl

Σ C

1..1

uri

Element id

Bundle.entry:prescription.fullUrl

Short description

UUID of the resource

Definition

This is a UUID to identify the element inside the Bundle. It SHALL start with urn:uuid: and then an UUID version 4 randomly generated. Its scope is only the Bundle, it is not linked outside from it and not saved.

Comments

Data type

uri

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-uuid: SHALL be a v4 UUID prefixed by urn:uuid:
startsWith('urn:uuid:') and length()=45

Examples
Valid example

urn:uuid:d00069b7-1fc8-4397-bc7c-c9571319d890

Mappings

rim: n/a

resource

Σ C

1..1

EPMedPrescription

Element id

Bundle.entry:prescription.resource

Short description

The prescription

Alternate names

Care Team

Definition

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

Data type

EPMedPrescription

Conditions

The cardinality or value of this element may be affected by these constraints: val-PrescriptionDate

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
val-PrescriptionDate: The date of creation of the prescription SHALL match its validity start date
period.start = created

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[classCode=PCPR, moodCode=INT]

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.search

Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

request

Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request

Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

method

1..1

codeBindingFixed Value

Element id

Bundle.entry:prescription.request.method

Short description

Definition

Constant

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.

HTTPVerb (required)

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

Fixed value

POST

Mappings

rim: n/a

url

1..1

uriFixed Value

Element id

Bundle.entry:prescription.request.url

Short description

Constant

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

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

Fixed value

CarePlan

Mappings

rim: n/a

ifNoneMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifModifiedSince

0..0

instant

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Comments

Data type

instant

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

Mappings

rim: n/a

ifMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.ifMatch

Short description

For managing update contention

Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifNoneExist

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.request.ifNoneExist

Short description

For conditional creates

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

response

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:prescription.response

Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

prescriptionLine

Σ C

1..*

BackboneElement

Element id

Bundle.entry:prescriptionLine

Short description

The prescription lines

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

BackboneElement

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() or (children().count() > id.count())
bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

link

0..0

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrl

Σ C

1..1

uri

Element id

Bundle.entry:prescriptionLine.fullUrl

Short description

UUID of the resource

Definition

Comments

Data type

uri

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-uuid: SHALL be a v4 UUID prefixed by urn:uuid:
startsWith('urn:uuid:') and length()=45

Mappings

rim: n/a

resource

Σ C

1..1

EPMedPrescriptionLine

Element id

Bundle.entry:prescriptionLine.resource

Short description

A prescription line

Alternate names

Prescription, Order

Definition

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Data type

EPMedPrescriptionLine

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Request
script10.6: Message/Body/NewRx
rim: CombinedMedicationRequest

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.search

Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

request

Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request

Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

method

1..1

codeBindingFixed Value

Element id

Bundle.entry:prescriptionLine.request.method

Short description

Definition

Constant

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.

HTTPVerb (required)

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

Fixed value

POST

Mappings

rim: n/a

url

1..1

uriFixed Value

Element id

Bundle.entry:prescriptionLine.request.url

Short description

Constant

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

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

Fixed value

MedicationRequest

Mappings

rim: n/a

ifNoneMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifModifiedSince

0..0

instant

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Comments

Data type

instant

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

Mappings

rim: n/a

ifMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.ifMatch

Short description

For managing update contention

Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifNoneExist

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.request.ifNoneExist

Short description

For conditional creates

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

response

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:prescriptionLine.response

Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

pdfDocument

Σ C

0..*

BackboneElement

Element id

Bundle.entry:pdfDocument

Short description

The prescription as PDF

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

BackboneElement

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() or (children().count() > id.count())
bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

link

0..0

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrl

Σ C

1..1

uri

Element id

Bundle.entry:pdfDocument.fullUrl

Short description

UUID of the resource

Definition

Comments

Data type

uri

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() or (children().count() > id.count())
val-uuid: SHALL be a v4 UUID prefixed by urn:uuid:
startsWith('urn:uuid:') and length()=45

Mappings

rim: n/a

resource

Σ C

1..1

EPMedDocumentRef

Element id

Bundle.entry:pdfDocument.resource

Short description

A reference to a document

Definition

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed.

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

EPMedDocumentRef

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
fhircomposition: when describing a Composition
rim: Document[classCode="DOC" and moodCode="EVN"]
cda: when describing a CDA

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.search

Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

request

Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request

Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

method

1..1

codeBindingFixed Value

Element id

Bundle.entry:pdfDocument.request.method

Short description

Constant

Definition

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.

HTTPVerb (required)

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

Fixed value

POST

Mappings

rim: n/a

url

1..1

uriFixed Value

Element id

Bundle.entry:pdfDocument.request.url

Short description

Constant

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

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

Fixed value

DocumentReference

Mappings

rim: n/a

ifNoneMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifModifiedSince

0..0

instant

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Comments

Data type

instant

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

Mappings

rim: n/a

ifMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.ifMatch

Short description

For managing update contention

Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifNoneExist

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.request.ifNoneExist

Short description

For conditional creates

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

response

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:pdfDocument.response

Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

nonRefMedication

Σ C

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

BackboneElement

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() or (children().count() > id.count())
bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

link

0..0

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrl

1..1

uri

Element id

Bundle.entry:nonRefMedication.fullUrl

Short description

UUID of the resource

Definition

Comments

Data type

uri

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

Mappings

rim: n/a

resource

Σ C

1..1

EPMedicationNoRef

Element id

Bundle.entry:nonRefMedication.resource

Short description

A reference to a medication

Definition

A medication that is not in the referential

Data type

EPMedicationNoRef

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
script10.6: NewRx/MedicationPrescribed -or- RxFill/MedicationDispensed -or- RxHistoryResponse/MedicationDispensed -or- RxHistoryResponse/MedicationPrescribed
rim: ManufacturedProduct[classCode=ADMM]

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.search

Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

request

Σ C

1..1

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request

Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

method

1..1

codeBindingFixed Value

Element id

Bundle.entry:nonRefMedication.request.method

Short description

Constant

Definition

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.

HTTPVerb (required)

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

Fixed value

POST

Mappings

rim: n/a

url

1..1

uriFixed Value

Element id

Bundle.entry:nonRefMedication.request.url

Short description

Constant

Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Data type

uri

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

Fixed value

Medication

Mappings

rim: n/a

ifNoneMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.ifNoneMatch

Short description

For managing cache currency

Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifModifiedSince

0..0

instant

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.ifModifiedSince

Short description

For managing cache currency

Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Comments

Data type

instant

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

Mappings

rim: n/a

ifMatch

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.ifMatch

Short description

For managing update contention

Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

ifNoneExist

0..0

string

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.request.ifNoneExist

Short description

For conditional creates

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a

response

Σ C

0..0

BackboneElement

There are no (further) constraints on this element

Element id

Bundle.entry:nonRefMedication.response

Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints

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

Mappings

rim: n/a

signature

0..0

Signature

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

Digital Signature - base64 encoded. XML-DSig or a JWT.

Requirements

A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

Comments

The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

Data type

Signature

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

Mappings

rim: n/a
rim: N/A

The Bundle is a conatainer to provide all resources (in Bundle.entry) that are part of the prescriptipon, i.e.:

The prescription document
Each prescription line
The PDF document of the prescription

The prescription document

A prescription document is represented by a CarePlan included in a Bundle :

EPMedPrescription (CarePlan)

CarePlan

Element id

CarePlan

Short description

Healthcare plan for patient or group

Alternate names

Care Team

Definition

Data type

CarePlan

Conditions

The cardinality or value of this element may be affected by these constraints: val-PrescriptionDate

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
val-PrescriptionDate: The date of creation of the prescription SHALL match its validity start date
period.start = created

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[classCode=PCPR, moodCode=INT]

0..1

Element id

CarePlan.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Is assigned by the server, do not provide a value.

Comments

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

Data type

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

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

CarePlan.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

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

Mappings

rim: n/a
rim: N/A

0..0

string

There are no (further) constraints on this element

Element id

CarePlan.meta.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

CarePlan.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

versionId

0..0

There are no (further) constraints on this element

Element id

CarePlan.meta.versionId

Short description

Version specific identifier

Definition

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

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.

Data type

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

Mappings

rim: n/a

lastUpdated

0..0

instant

There are no (further) constraints on this element

Element id

CarePlan.meta.lastUpdated

Short description

When the resource version last changed

Definition

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

Comments

Data type

instant

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

Mappings

rim: n/a

source

0..0

uri

There are no (further) constraints on this element

Element id

CarePlan.meta.source

Short description

Identifies where the resource comes from

Definition

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

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

Mappings

rim: n/a

profile

1..1

canonical(StructureDefinition)Fixed Value

Element id

CarePlan.meta.profile

Short description

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.

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.

Data type

canonical(StructureDefinition)

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

Fixed value

https://www.esante.lu/fhir-spec/StructureDefinition/EPMedPrescription

Mappings

rim: n/a

security

0..0

CodingBinding

There are no (further) constraints on this element

Element id

CarePlan.meta.security

Short description

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.

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.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..0

Coding

There are no (further) constraints on this element

Element id

CarePlan.meta.tag

Short description

Tags applied to this resource

Definition

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.

Data type

Coding

Binding

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

CommonTags (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

CarePlan.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

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

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

CarePlan.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

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

Mappings

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

contained

0..0

Resource

There are no (further) constraints on this element

Element id

CarePlan.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

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

extension

1..*

Extension

Element id

CarePlan.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Extension

Slicing

Unordered, Closed, 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() or (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

PatientInstruction

0..*

Extension(string)

Element id

CarePlan.extension:PatientInstruction

Short description

Instructions for the patient

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(string)

Extension URL

EPPatientInstructionText

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

OrderDetail

0..*

Extension(string)

Element id

CarePlan.extension:OrderDetail

Short description

Informations for the dispenser.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(string)

Extension URL

EPOrderDetail

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

contact

1..*

Extension

Element id

CarePlan.extension:contact

Short description

Contact

Alternate names

extensions, user content

Definition

At least one phone number shall be given so that the fulfiller can call back for questions

Comments

Data type

Extension

Extension URL

https://www.esante.lu/fhir-spec/StructureDefinition/EPContactExtension

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

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

CarePlan.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

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

identifier

1..1

EPSimpleIdentifier

Element id

CarePlan.identifier

Short description

Identifier of the prescription

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Requirements

Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

EPSimpleIdentifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
w5: FiveWs.identifier
v2: PTH-3
rim: .id

instantiatesCanonical

0..0

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

Comments

see Canonical References

Data type

canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)

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

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..0

uri

There are no (further) constraints on this element

Element id

CarePlan.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Data type

uri

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

Mappings

rim: n/a
workflow: Request.instantiatesUri
rim: .outboundRelationship[typeCode=DEFN].target

basedOn

Σ C

0..0

Reference(CarePlan)

There are no (further) constraints on this element

Element id

CarePlan.basedOn

Short description

Fulfills CarePlan

Alternate names

fulfills

Definition

A care plan that is fulfilled in whole or in part by this care plan.

Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(CarePlan)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

replaces

Σ C

0..0

Reference(CarePlan)

There are no (further) constraints on this element

Element id

CarePlan.replaces

Short description

CarePlan replaced by this CarePlan

Alternate names

supersedes

Definition

Completed or terminated care plan whose function is taken by this new care plan.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.

Comments

The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.

Data type

Reference(CarePlan)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

partOf

Σ C

0..0

Reference(CarePlan)

There are no (further) constraints on this element

Element id

CarePlan.partOf

Short description

Part of referenced CarePlan

Definition

A larger care plan of which this particular care plan is a component or step.

Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

Data type

Reference(CarePlan)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

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

status

Σ ?! C

1..1

codeBinding

Element id

CarePlan.status

Short description

Definition

Normally only active status are sent and retrieved, but a prescription itself may have another statuses

Requirements

Allows clinicians to determine whether the plan is actionable or not.

Comments

The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.

This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.

Data type

code

Binding

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

RequestStatus (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-presStatus: Only the statuses active, completed or revoked are used
($this = 'active') or ($this = 'completed') or ($this = 'revoked') or ($this = 'entered-in-error')

Mappings

rim: n/a
workflow: Request.status {uses different ValueSet}
w5: FiveWs.status
v2: PTH-5
rim: .statusCode planned = new active = active completed = completed

intent

Σ ?!

1..1

codeBindingFixed Value

Element id

CarePlan.intent

Short description

proposal | plan | order | option

Definition

Constant

Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Data type

code

Binding

Codes indicating the degree of authority/intentionality associated with a care plan.

CarePlanIntent (required)

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

Fixed value

order

Mappings

rim: n/a
workflow: Request.intent

The prescription lines

Each MedicationRequest represents a prescription line:

EPMedPrescriptionLine (MedicationRequest)

MedicationRequest

Element id

MedicationRequest

Short description

A prescription line

Alternate names

Prescription, Order

Definition

Data type

MedicationRequest

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Request
script10.6: Message/Body/NewRx
rim: CombinedMedicationRequest

0..1

Element id

MedicationRequest.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Is assigned by the server, do not provide a value.

Comments

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

Data type

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

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

MedicationRequest.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

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

Mappings

rim: n/a
rim: N/A

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.meta.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

versionId

0..0

There are no (further) constraints on this element

Element id

MedicationRequest.meta.versionId

Short description

Version specific identifier

Definition

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

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.

Data type

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

Mappings

rim: n/a

lastUpdated

0..0

instant

There are no (further) constraints on this element

Element id

MedicationRequest.meta.lastUpdated

Short description

When the resource version last changed

Definition

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

Comments

Data type

instant

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

Mappings

rim: n/a

source

0..0

uri

There are no (further) constraints on this element

Element id

MedicationRequest.meta.source

Short description

Identifies where the resource comes from

Definition

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

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

Mappings

rim: n/a

profile

1..1

canonical(StructureDefinition)Fixed Value

Element id

MedicationRequest.meta.profile

Short description

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.

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.

Data type

canonical(StructureDefinition)

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

Fixed value

https://www.esante.lu/fhir-spec/StructureDefinition/EPMedPrescriptionLine

Mappings

rim: n/a

security

0..0

CodingBinding

There are no (further) constraints on this element

Element id

MedicationRequest.meta.security

Short description

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.

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.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..0

Coding

There are no (further) constraints on this element

Element id

MedicationRequest.meta.tag

Short description

Tags applied to this resource

Definition

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.

Data type

Coding

Binding

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

CommonTags (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..0

uri

There are no (further) constraints on this element

Element id

MedicationRequest.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

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

Mappings

rim: n/a

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationRequest.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

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

Mappings

rim: n/a

text

0..0

Narrative

There are no (further) constraints on this element

Element id

MedicationRequest.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

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

Mappings

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

contained

0..0

Resource

There are no (further) constraints on this element

Element id

MedicationRequest.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Mappings

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Slicing

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

identifier

1..1

EPSimpleIdentifier

Element id

MedicationRequest.identifier

Short description

Identifier of the prescription line

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Comments

This is a business identifier, not a resource identifier.

Data type

EPSimpleIdentifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
script10.6: Message/Header/PrescriberOrderNumber
w5: FiveWs.identifier
v2: ORC-2-Placer Order Number / ORC-3-Filler Order Number
rim: .id

status

Σ ?! C

1..1

codeBinding

Element id

MedicationRequest.status

Short description

Definition

A code specifying the current state of the order. Generally, this will be active or completed state.

Comments

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

Data type

code

Binding

A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

medicationrequest Status (required)

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-activeOrCompleted: Only active or completed is allowed
$this="active" or $this="completed"

Mappings

rim: n/a
workflow: Request.status
script10.6: no mapping
w5: FiveWs.status
rim: .statusCode

statusReason

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.statusReason

Short description

Reason for current status

Definition

Captures the reason for the current state of the MedicationRequest.

Comments

This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.

Data type

CodeableConcept

Binding

Identifies the reasons for a given status.

medicationRequest Status Reason Codes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.statusReason
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

intent

Σ ?!

1..1

codeBindingFixed Value

Element id

MedicationRequest.intent

Short description

order

Definition

Constant

Comments

It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.

An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Data type

code

Binding

The kind of medication order.

medicationRequest Intent (required)

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

Fixed value

order

Mappings

rim: n/a
workflow: Request.intent
w5: FiveWs.class
rim: .moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)

category

1..1

CodeableConcept

Element id

MedicationRequest.category

Short description

Type of request

Definition

Constant

Comments

The category can be used to include where the medication is expected to be consumed or other types of requests.

Data type

CodeableConcept

Binding

A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.

medicationRequest Category Codes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
script10.6: Message/Body/NewRx/MedicationPrescribed/Directions or Message/Body/NewRx/MedicationPrescribed/StructuredSIG
w5: FiveWs.class
rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication usage"].value

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.category.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

coding

1..1

CodingFixed Value

Element id

MedicationRequest.category.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Coding

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

Fixed value

{
  "system": "urn:oid:1.3.182.5.56",
  "code": "MED_PRESC_LINE"
}

Mappings

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

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

Data type

uri

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

Fixed value

urn:oid:1.3.182.5.56

Mappings

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

version

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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

Mappings

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

code

1..1

codeFixed Value

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.code

Short description

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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

Fixed value

MED_PRESC_LINE

Mappings

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

display

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

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

userSelected

0..0

boolean

There are no (further) constraints on this element

Element id

MedicationRequest.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

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

Data type

boolean

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

Mappings

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

text

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.category.text

Short description

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.

Requirements

Comments

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

Data type

string

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

Mappings

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

priority

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationRequest.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the Medication Request should be addressed with respect to other requests.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

Identifies the level of importance to be assigned to actioning the request.

RequestPriority (required)

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

Mappings

rim: n/a
workflow: Request.priority
w5: FiveWs.grade
rim: .priorityCode

doNotPerform

Σ ?!

0..0

boolean

There are no (further) constraints on this element

Element id

MedicationRequest.doNotPerform

Short description

True if request is prohibiting action

Definition

If true indicates that the provider is asking for the medication request not to occur.

Comments

If do not perform is not specified, the request is a positive request e.g. "do perform".

Data type

boolean

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

Mappings

rim: n/a
rim: SubstanceAdministration.actionNegationInd

reported[x]

0..0

There are no (further) constraints on this element

Element id

MedicationRequest.reported[x]

Short description

Reported rather than primary record

Definition

Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

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

Mappings

rim: n/a
rim: .participation[typeCode=INF].role

medication[x]

1..1

Reference(EPMedicationNoRef | EPMedicationPrescription)

Element id

MedicationRequest.medication[x]

Short description

Medication to be taken

Definition

Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.

Data type

Reference(EPMedicationNoRef | EPMedicationPrescription)

Allowed aggregation:referenced, bundled

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

Mappings

rim: n/a
workflow: Request.code
script10.6: Message/Body/NewRx/MedicationPrescribed Medication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode Medication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier Medication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription
w5: FiveWs.what[x]
v2: RXE-2-Give Code / RXO-1-Requested Give Code / RXC-2-Component Code
rim: consumable.administrableMedication

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.medication[x].id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.medication[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

reference

Σ C

1..1

string

Element id

MedicationRequest.medication[x].reference

Short description

A medication

Definition

See examples: If the medication is in the referential, simply link to it through the prescription code If the medication is not in the referential, you have to create it, put it in the Bundle and link to it through its fullURL

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1, val-refMedicationPres

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-refMedicationPres: SHALL reference a prescriptable medication by its identifier or by its fullURL
(startsWith('Medication?identifier=urn:oid:1.3.182.5.47|') and length()=53) or (startsWith('Medication/urn:uuid:') and length()=56)

Examples
Known medication

Medication?identifier=urn:oid:1.3.182.5.47|2006028443

Medication not in the referential

Medication/urn:uuid:595bbd26-b841-4028-817d-adbcc4cdad3b

Mappings

rim: n/a
rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

MedicationRequest.medication[x].type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

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

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

MedicationRequest.medication[x].identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Identifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.medication[x].display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

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

Mappings

rim: n/a
rim: N/A

subject

Σ C

1..1

Reference(Patient)

Element id

MedicationRequest.subject

Short description

The patient

Definition

A link to a resource representing the person or set of individuals to whom the medication will be given.

Comments

The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.

Data type

Reference(Patient)

Allowed aggregation:referenced

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
script10.6: Message/Body/NewRx/Patient (need detail to link to specific patient … Patient.Identification in SCRIPT)
w5: FiveWs.subject[x]
v2: PID-3-Patient ID List
rim: .participation[typeCode=AUT].role
w5: FiveWs.subject

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.subject.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.subject.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

reference

Σ C

1..1

string

Element id

MedicationRequest.subject.reference

Short description

The patient referenced by its matricule

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1, val-patByMatricule

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-patByMatricule: The Patient SHALL be referenced by its matricule
startsWith('Patient?identifier=urn:oid:1.3.182.4.4|') and length()=52

Examples
Example

Patient?identifier=urn:oid:1.3.182.4.4|1904112000166

Mappings

rim: n/a
rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

MedicationRequest.subject.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

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

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

MedicationRequest.subject.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Identifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.subject.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

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

Mappings

rim: n/a
rim: N/A

encounter

0..0

Reference(Encounter)

There are no (further) constraints on this element

Element id

MedicationRequest.encounter

Short description

Encounter created as part of encounter/admission/stay

Definition

The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.

Data type

Reference(Encounter)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.context
script10.6: no mapping
w5: FiveWs.context
v2: PV1-19-Visit Number
rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]

supportingInformation

0..0

Reference(Resource)

There are no (further) constraints on this element

Element id

MedicationRequest.supportingInformation

Short description

Information to support ordering of the medication

Definition

Include additional information (for example, patient height and weight) that supports the ordering of the medication.

Comments

Data type

Reference(Resource)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo
w5: FiveWs.context
rim: .outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]

authoredOn

1..1

dateTime

Element id

MedicationRequest.authoredOn

Short description

Prescrpition date

Definition

The date (and perhaps time) when the prescription was initially written or authored on.

Data type

dateTime

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

Mappings

rim: n/a
workflow: Request.authoredOn
script10.6: Message/Body/NewRx/MedicationPrescribed/WrittenDate
w5: FiveWs.recorded
v2: RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction
rim: author.time

requester

Σ C

1..1

Reference(EPPractitioner)

Element id

MedicationRequest.requester

Short description

The prescriber

Definition

The individual, organization, or device that initiated the request and has responsibility for its activation.

Comments

Data type

Reference(EPPractitioner)

Allowed aggregation:referenced

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester
w5: FiveWs.author
rim: .participation[typeCode=AUT].role

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.requester.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.requester.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

reference

Σ C

1..1

string

Element id

MedicationRequest.requester.reference

Short description

A health professional referenced by its eHealthID

Definition

Comments

Data type

string

Conditions

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
val-1: A Practitioner SHALL be referenced by its eHealthID
startsWith('Practitioner?identifier=urn:oid:1.3.182.4.1|2') and length()=54

Examples
Example

Practitioner?identifier=urn:oid:1.3.182.4.1|2999999617

Mappings

rim: n/a
rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

MedicationRequest.requester.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

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

Mappings

rim: n/a
rim: N/A

identifier

0..0

Identifier

There are no (further) constraints on this element

Element id

MedicationRequest.requester.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Identifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.requester.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

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

Mappings

rim: n/a
rim: N/A

performer

0..0

There are no (further) constraints on this element

Element id

MedicationRequest.performer

Short description

Intended performer of administration

Definition

The specified desired performer of the medication treatment (e.g. the performer of the medication administration).

Comments

Data type

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
w5: FiveWs.actor
rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

performerType

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.performerType

Short description

Desired kind of performer of the medication administration

Definition

Indicates the type of performer of the administration of the medication.

Comments

If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.

Data type

CodeableConcept

Binding

Identifies the type of individual that is desired to administer the medication.

ProcedurePerformerRoleCodes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.performerType
rim: .participation[typeCode=PRF].role[scoper.determinerCode=KIND].code

recorder

0..0

Reference(Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

MedicationRequest.recorder

Short description

Person who entered the request

Definition

The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

Comments

Data type

Reference(Practitioner | PractitionerRole)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.who
rim: .participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)

reasonCode

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.reasonCode

Short description

Reason or indication for ordering or not ordering the medication

Definition

The reason or the indication for ordering or not ordering the medication.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.

Data type

CodeableConcept

Binding

A coded concept indicating why the medication was ordered.

Condition/Problem/DiagnosisCodes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode
script10.6: Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value
w5: FiveWs.why[x]
v2: ORC-16-Order Control Code Reason /RXE-27-Give Indication/RXO-20-Indication / RXD-21-Indication / RXG-22-Indication / RXA-19-Indication
rim: reason.observation.reasonCode

reasonReference

0..0

Reference(Condition | Observation)

There are no (further) constraints on this element

Element id

MedicationRequest.reasonReference

Short description

Condition or observation that supports why the prescription is being written

Definition

Condition or observation that supports why the medication was ordered.

Comments

This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.

Data type

Reference(Condition | Observation)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
script10.6: no mapping
w5: FiveWs.why[x]
rim: reason.observation[code=ASSERTION].value

instantiatesCanonical

0..0

canonical

There are no (further) constraints on this element

Element id

MedicationRequest.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.

Comments

see Canonical References

Data type

canonical

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

Mappings

rim: n/a
workflow: Request.instantiates
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..0

uri

There are no (further) constraints on this element

Element id

MedicationRequest.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.

Comments

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

Data type

uri

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

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=DEFN].target

basedOn

Σ C

0..0

Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | ServiceRequest)

There are no (further) constraints on this element

Element id

MedicationRequest.basedOn

Short description

What request fulfills

Definition

A plan or request that is fulfilled in whole or in part by this medication request.

Comments

Data type

Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | ServiceRequest)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn
rim: .outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]

groupIdentifier

0..0

Identifier

There are no (further) constraints on this element

Element id

MedicationRequest.groupIdentifier

Short description

Composite request this is part of

Definition

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.

Requirements

Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Data type

Identifier

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.groupIdentifier
rim: .outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id

courseOfTherapyType

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.courseOfTherapyType

Short description

Overall pattern of medication administration

Definition

The description of the overall patte3rn of the administration of the medication to the patient.

Comments

This attribute should not be confused with the protocol of the medication.

Data type

CodeableConcept

Binding

Identifies the overall pattern of medication administratio.

medicationRequest Course of Therapy Codes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: Act.code where classCode = LIST and moodCode = EVN

insurance

0..0

Reference(ClaimResponse | Coverage)

There are no (further) constraints on this element

Element id

MedicationRequest.insurance

Short description

Associated insurance coverage

Definition

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

Comments

Data type

Reference(ClaimResponse | Coverage)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.insurance
rim: .outboundRelationship[typeCode=COVBY].target

note

0..0

Annotation

There are no (further) constraints on this element

Element id

MedicationRequest.note

Short description

Information about the prescription

Definition

Extra information about the prescription that could not be conveyed by the other attributes.

Comments

Data type

Annotation

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

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note
script10.6: Message/Body/NewRx/MedicationPrescribed/Note
rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code="annotation"].value

dosageInstruction

1..*

Dosage

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction

Short description

How the medication should be taken

Definition

Indicates how the medication is to be used by the patient.

Comments

There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

Data type

Dosage

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

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
workflow: Request.occurrence[x]
rim: see dosageInstruction mapping

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

sequence

0..0

integer

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.sequence

Short description

The order of the dosage instructions

Definition

Indicates the order in which the dosage instructions should be applied or interpreted.

Requirements

If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.

Comments

32 bit number; for values larger than this, use decimal

Data type

integer

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

Mappings

rim: n/a
v2: TQ1-1
rim: .text

text

0..1

string

Element id

MedicationRequest.dosageInstruction.text

Short description

Free text dosage instructions

Definition

Free text dosage instructions e.g. SIG.

Requirements

Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a
v2: RXO-6; RXE-21
rim: .text

additionalInstruction

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.additionalInstruction

Short description

Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"

Definition

Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

Requirements

Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.

Comments

Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text.

Data type

CodeableConcept

Binding

A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

SNOMEDCTAdditionalDosageInstructions (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXO-7
rim: .text

patientInstruction

0..1

string

Element id

MedicationRequest.dosageInstruction.patientInstruction

Short description

Patient oriented instructions

Definition

Instructions in terms that are understood by the patient or consumer.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

rim: n/a
v2: RXO-7
rim: .text

timing

0..1

Timing

Element id

MedicationRequest.dosageInstruction.timing

Short description

When medication should be taken

Definition

When medication should be administered.

Requirements

The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Comments

This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.

Data type

Timing

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

Mappings

rim: n/a
v2: N/A
rim: QSET<TS> (GTS)
rim: .effectiveTime

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

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

event

0..0

dateTime

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.event

Short description

When the event occurs

Definition

Identifies specific times when the event occurs.

Requirements

In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

Data type

dateTime

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

Mappings

rim: n/a
rim: QLIST<TS>

repeat

Σ C

1..1

Element

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat

Short description

When the event is to occur

Definition

A set of rules that describe when the event is scheduled.

Requirements

Many timing schedules are determined by regular repetitions.

Data type

Element

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() or (children().count() > id.count())
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-5: period SHALL be a non-negative value
period.exists() implies period >= 0
tim-6: If there's a periodMax, there must be a period
periodMax.empty() or period.exists()
tim-7: If there's a durationMax, there must be a duration
durationMax.empty() or duration.exists()
tim-8: If there's a countMax, there must be a count
countMax.empty() or count.exists()
tim-1: if there's a duration, there needs to be duration units
duration.empty() or durationUnit.exists()
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
timeOfDay.empty() or when.empty()
tim-2: if there's a period, there needs to be period units
period.empty() or periodUnit.exists()
tim-4: duration SHALL be a non-negative value
duration.exists() implies duration >= 0

Mappings

rim: n/a
rim: Implies PIVL or EIVL

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

bounds[x]

0..1

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.bounds[x]

Short description

Length/Range of lengths, or (Start and/or end) limits

Definition

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

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

Mappings

rim: n/a
rim: IVL(TS) used in a QSI

boundsDuration

Data type

boundsPeriod

Data type

count

0..1

positiveInt

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.count

Short description

Number of times to repeat

Definition

A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.

Requirements

Repetitions may be limited by end time or total occurrences.

Comments

If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

Data type

positiveInt

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

Mappings

rim: n/a
rim: PIVL.count

countMax

0..1

positiveInt

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.countMax

Short description

Maximum number of times to repeat

Definition

If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

Comments

32 bit number; for values larger than this, use decimal

Data type

positiveInt

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

Mappings

rim: n/a
rim: PIVL.count

duration

0..1

decimal

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.duration

Short description

How long when it happens

Definition

How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

Requirements

Some activities are not instantaneous and need to be maintained for a period of time.

Comments

For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

Data type

decimal

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

Mappings

rim: n/a
rim: PIVL.phase

durationMax

0..1

decimal

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.durationMax

Short description

How long when it happens (Max)

Definition

If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

Requirements

Some activities are not instantaneous and need to be maintained for a period of time.

Comments

Data type

decimal

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

Mappings

rim: n/a
rim: PIVL.phase

durationUnit

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.durationUnit

Short description

s | min | h | d | wk | mo | a - unit of time (UCUM)

Definition

The units of time for the duration, in UCUM units.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

A unit of time (units from UCUM).

UnitsOfTime (required)

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

Mappings

rim: n/a
rim: PIVL.phase.unit

frequency

0..1

positiveInt

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.frequency

Short description

Event occurs frequency times per period

Definition

The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

Comments

32 bit number; for values larger than this, use decimal

Meaning when missing

If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this

Data type

positiveInt

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

Mappings

rim: n/a
rim: PIVL.phase

frequencyMax

0..1

positiveInt

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.frequencyMax

Short description

Event occurs up to frequencyMax times per period

Definition

If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

Comments

32 bit number; for values larger than this, use decimal

Data type

positiveInt

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

Mappings

rim: n/a
rim: PIVL.phase

period

0..1

decimal

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.period

Short description

Event occurs frequency times per period

Definition

Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

Comments

Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)

Data type

decimal

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

Mappings

rim: n/a
rim: PIVL.phase

periodMax

0..1

decimal

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.periodMax

Short description

Upper limit of period (3-4 hours)

Definition

If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

Comments

Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)

Data type

decimal

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

Mappings

rim: n/a
rim: PIVL.phase

periodUnit

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.periodUnit

Short description

s | min | h | d | wk | mo | a - unit of time (UCUM)

Definition

The units of time for the period in UCUM units.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

A unit of time (units from UCUM).

UnitsOfTime (required)

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

Mappings

rim: n/a
rim: PIVL.phase.unit

dayOfWeek

0..*

codeBinding

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek

Short description

mon | tue | wed | thu | fri | sat | sun

Definition

If one or more days of week is provided, then the action happens only on the specified day(s).

Comments

If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.

Data type

code

Binding

DaysOfWeek (required)

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

Mappings

rim: n/a

timeOfDay

0..*

time

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.timeOfDay

Short description

Time of day for action

Definition

Specified time of day for action to take place.

Comments

When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.

Data type

time

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

Mappings

rim: n/a

when

0..*

codeBinding

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.when

Short description

Code for time period of occurrence

Definition

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Requirements

Timings are frequently determined by occurrences such as waking, eating and sleep.

Comments

When more than one event is listed, the event is tied to the union of the specified events.

Data type

code

Binding

Real world event relating to the schedule.

EventTiming (required)

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

Mappings

rim: n/a
rim: EIVL.event

offset

0..1

unsignedInt

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.repeat.offset

Short description

Minutes from event (before or after)

Definition

The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.

Comments

32 bit number; for values larger than this, use decimal

Data type

unsignedInt

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

Mappings

rim: n/a
rim: EIVL.offset

code

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.timing.code

Short description

BID | TID | QID | AM | PM | QD | QOD | +

Definition

A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

Comments

BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

Data type

CodeableConcept

Binding

Code for a known / defined timing pattern.

TimingAbbreviation (preferred)

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

Mappings

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

asNeeded[x]

0..0

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.asNeeded[x]

Short description

Take "as needed" (for x)

Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

Comments

Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

Binding

A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

SNOMEDCTMedicationAsNeededReasonCodes (example)

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

Mappings

rim: n/a
v2: TQ1-9
rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept

site

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.site

Short description

Body site to administer to

Definition

Body site to administer to.

Requirements

A coded specification of the anatomic site where the medication first enters the body.

Comments

If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

Data type

CodeableConcept

Binding

A coded concept describing the site location the medicine enters into or onto the body.

SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-2
rim: .approachSiteCode

route

0..1

EPCodeableConcept

Element id

MedicationRequest.dosageInstruction.route

Short description

Route of administration

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Requirements

A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

Comments

There are 3 ways to use this ressource: (see examples)

1: If only a textual representation is possible, use text and don't use coding. This is also how to prescribe something which is not in the referential
2: If there is a code and the referential doesn't ask for "additionalText", use only coding and not text
3: If there is a code and the referential does ask for "additionalText", use coding and provide information in text

Data type

EPCodeableConcept

Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)

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

Examples
Case 1

{
  "text": "Patient bélonéphobie"
}

Case 2

{
  "coding": [
    {
      "system": "urn:oid:1.3.182.5.53",
      "code": "127"
    }
  ]
}

Case 3

{
  "coding": [
    {
      "system": "urn:oid:1.3.182.5.53",
      "code": "143"
    }
  ],
  "text": "narine gauche"
}

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-1
rim: .routeCode

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

coding

0..1

CodingBinding

Element id

MedicationRequest.dosageInstruction.route.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Coding

Binding

EPPharRoutes (required)

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

Mappings

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

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

system

1..1

uri

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

Data type

uri

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

Mappings

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

version

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

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

Mappings

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

code

1..1

code

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.code

Short description

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

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

Mappings

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

display

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

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

Mappings

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

userSelected

0..0

boolean

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

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

Data type

boolean

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

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.route.text

Short description

Plain text representation of the concept

Definition

Can also serve as details if the code need precision

Requirements

Comments

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

Data type

string

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

Mappings

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

method

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.method

Short description

Technique for administering medication

Definition

Technique for administering medication.

Requirements

A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

Comments

Terminologies used often pre-coordinate this term with the route and or form of administration.

Data type

CodeableConcept

Binding

A coded concept describing the technique by which the medicine is administered.

SNOMEDCTAdministrationMethodCodes (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-4
rim: .doseQuantity

doseAndRate

0..*

Element

Element id

MedicationRequest.dosageInstruction.doseAndRate

Short description

Amount of medication

Definition

The amount of medication administered.

Data type

Element

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

Mappings

rim: n/a
v2: TQ1-2

0..0

string

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.doseAndRate.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.doseAndRate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

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

type

0..0

CodeableConcept

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.doseAndRate.type

Short description

The kind of dose or rate specified

Definition

The kind of dose or rate specified, for example, ordered or calculated.

Requirements

If the type is not populated, assume to be "ordered".

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CodeableConcept

Binding

The kind of dose or rate specified.

DoseAndRateType (example)

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXO-21; RXE-23

dose[x]

0..1

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.doseAndRate.dose[x]

Short description

Amount of medication per dose

Definition

Amount of medication per dose.

Requirements

The amount of therapeutic or other substance given at one administration event.

Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

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

Mappings

rim: n/a
v2: RXO-2, RXE-3
rim: .doseQuantity

doseQuantity

SimpleQuantity

There are no (further) constraints on this element

Data type

SimpleQuantity

doseRange

Range

There are no (further) constraints on this element

Data type

Range

rate[x]

0..1

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.doseAndRate.rate[x]

Short description

Amount of medication per unit of time

Definition

Amount of medication per unit of time.

Requirements

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Comments

It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.

It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.

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

Mappings

rim: n/a
v2: RXE22, RXE23, RXE-24
rim: .rateQuantity

rateQuantity

SimpleQuantity

There are no (further) constraints on this element

Data type

SimpleQuantity

rateRange

Range

There are no (further) constraints on this element

Data type

Range

rateRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

maxDosePerPeriod

Σ C

0..0

Ratio

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.maxDosePerPeriod

Short description

Upper limit on medication per unit of time

Definition

Upper limit on medication per unit of time.

Requirements

The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

Comments

This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".

Data type

Ratio

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() or (children().count() > id.count())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
v2: N/A
rim: RTO
v2: RXO-23, RXE-19
rim: .maxDoseQuantity

maxDosePerAdministration

Σ C

0..0

SimpleQuantity

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.maxDosePerAdministration

Short description

Upper limit on medication per administration

Definition

Upper limit on medication per administration.

Requirements

The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.

Comments

This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.

Data type

SimpleQuantity

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() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: not supported

maxDosePerLifetime

Σ C

0..0

SimpleQuantity

There are no (further) constraints on this element

Element id

MedicationRequest.dosageInstruction.maxDosePerLifetime

Short description

Upper limit on medication per lifetime of the patient

Definition

Upper limit on medication per lifetime of the patient.

Requirements

The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

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() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: not supported

dispenseRequest

0..0

BackboneElement

There are no (further) constraints on this element

Element id

MedicationRequest.dispenseRequest

Short description

Medication supply authorization

Definition

Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

Data type

BackboneElement

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

Mappings

rim: n/a
script10.6: Message/Body/NewRx/MedicationPrescribed/ExpirationDate
rim: component.supplyEvent

substitution

0..0

BackboneElement

There are no (further) constraints on this element

Element id

MedicationRequest.substitution

Short description

Any restrictions on medication substitution

Definition

Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

Data type

BackboneElement

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

Mappings

rim: n/a
script10.6: specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions
rim: subjectOf.substitutionPersmission

priorPrescription

0..0

Reference(MedicationRequest)

There are no (further) constraints on this element

Element id

MedicationRequest.priorPrescription

Short description

An order/prescription that is being replaced

Definition

A link to a resource representing an earlier order related order or prescription.

Comments

Data type

Reference(MedicationRequest)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces
script10.6: not mapped
rim: .outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]

detectedIssue

0..0

Reference(DetectedIssue)

There are no (further) constraints on this element

Element id

MedicationRequest.detectedIssue

Short description

Clinical Issue with action

Alternate names

Contraindication, Drug Utilization Review (DUR), Alert

Definition

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.

Comments

This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.

Data type

Reference(DetectedIssue)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value

eventHistory

0..0

Reference(Provenance)

There are no (further) constraints on this element

Element id

MedicationRequest.eventHistory

Short description

A list of events of interest in the lifecycle

Definition

Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Comments

This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

Data type

Reference(Provenance)

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() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.relevantHistory
rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]

The posology is in dosageInstructions. The medication[x] element can refer either to a medication known in the referential, or to a free-text one. In this case, don't forget to add it in the Bundle.

Additional information

The other useful resources to consider are:

DocumentReference (the PDF)