Primary Care Data Standard

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.meta.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.meta.versionId

Short Version specific identifier

Definition

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

Cardinality 0..1

Summary True

Comments

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

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.meta.lastUpdated

Short When the resource version last changed

Definition

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

Cardinality 0..1

instant

Summary True

Comments

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

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.meta.profile

Short Profiles this resource claims to conform to

Definition

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

Cardinality 1..*

Summary True

Comments

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

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.meta.security

Short Security Labels applied to this resource

Definition

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

Cardinality 0..*

All Security Labels (extensible)

Security Labels from the Healthcare Privacy and Security Classification System.

Summary True

Comments

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

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

Constraints

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

Mappings

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

MedicationRequest.meta.tag

Short Tags applied to this resource

Definition

Cardinality 0..*

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

Common Tags (example)

Summary True

Comments

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

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

Constraints

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

Mappings

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

MedicationRequest.implicitRules

Short A set of rules under which this content was created

Definition

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

Cardinality 0..1

Modifier True

Summary True

Comments

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

A human language.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Comments

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Narrative

Alias narrative, html, xhtml, display

Comments

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

Constraints

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

Mappings

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

MedicationRequest.contained

Short Contained, inline Resources

Definition

Cardinality 0..*

Resource

Alias inline resources, anonymous resources, contained resources

Comments

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

Mappings

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

MedicationRequest.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation

Short Medication repeat information

Definition

Medication repeat information.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.extension:repeatInformation.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed

Short Number of repeat prescriptions authorised

Definition

Number of repeat prescriptions authorised.

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Comments

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

Constraints

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

Fixed Value

numberOfRepeatPrescriptionsAllowed

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsAllowed.value[x]:valueUnsignedInt

Short Number of issues authorised

Definition

Number of issues authorised.

Cardinality 1..1

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued

Short Number of repeat prescriptions issued

Definition

Number of repeat prescriptions issued.

Cardinality 1..1

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Comments

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

Constraints

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

Fixed Value

numberOfRepeatPrescriptionsIssued

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:numberOfRepeatPrescriptionsIssued.value[x]:valueUnsignedInt

Short Number of issues issued

Definition

Number of issues issued.

Cardinality 0..1

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate

Short Repeat prescription review date

Definition

Repeat prescription review date.

Cardinality 0..1

Must Support True

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Comments

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

Constraints

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

Fixed Value

authorisationExpiryDate

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.extension:authorisationExpiryDate.value[x]:valueDateTime

Short Repeat review date

Definition

Repeat review date.

Cardinality 0..1

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Comments

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

Constraints

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

Fixed Value

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationRepeatInformation-1

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:repeatInformation.value[x]

Short Value of extension

Definition

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

Cardinality 0..0

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:statusReason

Short To record the reason the medication (plan or order) was stopped and the date this occurred

Definition

To record the reason the medication (plan or order) was stopped and the date this occurred.

Cardinality 0..1

Type Extension(Complex)

Must Support True

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.extension:prescriptionType

Short To record the type of prescription

Definition

To record the type of prescription.

Cardinality 0..1

Type Extension(CodeableConcept)

Must Support True

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.identifier

Short External ids for this request

Definition

Cardinality 1..*

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() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: …identifer
script10.6: Message/Header/PrescriberOrderNumber
v2: ORC-2-Placer Order Number / ORC-3-Filler Order Number
rim: .id
w5: id

MedicationRequest.identifier.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.identifier.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.identifier.use

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

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

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

MedicationRequest.identifier.type

Short Description of identifier

Definition

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

Cardinality 0..1

Identifier Type Codes (extensible)

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

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

MedicationRequest.identifier.system

Short The namespace for the identifier value

Definition

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

Cardinality 1..1

Summary True

Requirements

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

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_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() | (children().count() > id.count())

Examples

General

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

Mappings

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

MedicationRequest.identifier.value

Short The value that is unique

Definition

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

Cardinality 1..1

Summary True

Comments

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

Constraints

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

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

MedicationRequest.identifier.period

Short Time period when id is/was valid for use

Definition

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

Cardinality 0..1

Period

Summary True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

MedicationRequest.identifier.assigner

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

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

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

MedicationRequest.definition

Short Protocol or definition

Definition

Protocol or definition followed by this request.

Cardinality 0..*

Type Reference(ActivityDefinition | PlanDefinition)

Summary True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: …definition
rim: .outboundRelationship[typeCode=DEFN].target[classCode=unspecified]

MedicationRequest.basedOn

Short What request fulfills

Definition

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

Cardinality 0..*

Type Reference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-GPC-MedicationRequest-1)

Must Support True

Summary True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

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

MedicationRequest.groupIdentifier

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

Cardinality 0..1

Identifier

Must Support True

Summary True

Requirements

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

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: …groupIdentifier
rim: .outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id

MedicationRequest.groupIdentifier.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.groupIdentifier.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.groupIdentifier.use

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

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

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

MedicationRequest.groupIdentifier.type

Short Description of identifier

Definition

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

Cardinality 0..1

Identifier Type Codes (extensible)

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

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

MedicationRequest.groupIdentifier.system

Short The namespace for the identifier value

Definition

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

Cardinality 0..1

Summary True

Requirements

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

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_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() | (children().count() > id.count())

Examples

General

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

Mappings

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

MedicationRequest.groupIdentifier.value

Short The value that is unique

Definition

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

Cardinality 0..1

Summary True

Comments

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

Constraints

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

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

MedicationRequest.groupIdentifier.period

Short Time period when id is/was valid for use

Definition

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

Cardinality 0..1

Period

Summary True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

MedicationRequest.groupIdentifier.assigner

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Summary True

Comments

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

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

MedicationRequest.status

Definition

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

Cardinality 1..1

MedicationRequestStatus (required)

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

Modifier True

Summary True

Comments

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

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

Constraints

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

Mappings

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

MedicationRequest.intent

Short proposal | plan | order | instance-order

Definition

Whether the request is a proposal, plan, or an original order.

Cardinality 1..1

MedicationRequestIntent (required)

The kind of medication order

Modifier True

Summary True

Comments

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.

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

Constraints

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

Mappings

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

MedicationRequest.category

Short Type of medication usage

Definition

Indicates the type of medication order and where the medication is expected to be consumed or administered.

Cardinality 0..1

MedicationRequestCategory (preferred)

A coded concept identifying where the medication ordered is expected to be consumed or administered

Comments

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

Constraints

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

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
rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication usage"].value
w5: class

MedicationRequest.priority

Short routine | urgent | stat | asap

Definition

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

Cardinality 0..1

MedicationRequestPriority (required)

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

Summary True

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a
workflow: …priority
rim: .priorityCode
w5: grade

MedicationRequest.medication[x]

Short Medication to be taken

Definition

Cardinality 1..1

Type CodeableConcept | Reference(CareConnect-GPC-Medication-1)

SNOMED CT Medication Codes (example)

A coded concept identifying substance or product that can be ordered.

Summary True

Comments

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

Constraints

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

Mappings

rim: n/a
workflow: …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
v2: RXE-2-Give Code / RXO-1-Requested Give Code / RXC-2-Component Code
rim: consumable.administrableMedication
w5: what

MedicationRequest.subject

Short Who or group medication request is for

Definition

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

Cardinality 1..1

Type Reference(Group | CareConnect-GPC-Patient-1)

Summary True

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.

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

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

MedicationRequest.context

Short Created during encounter/admission/stay

Definition

A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.

Cardinality 0..1

Type Reference(EpisodeOfCare | CareConnect-Encounter-1)

Must Support True

Comments

SubstanceAdministration->component->EncounterEvent.

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

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

MedicationRequest.supportingInformation

Short Information to support ordering of the medication

Definition

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

Cardinality 0..*

Type Reference(Resource)

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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)]
w5: context

MedicationRequest.authoredOn

Short When request was initially authored

Definition

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

Cardinality 1..1

Summary True

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

Constraints

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

Mappings

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

MedicationRequest.requester

Short Who/What requested the Request

Definition

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

Cardinality 0..1

BackboneElement

Must Support True

Summary True

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
mps-1: onBehalfOf can only be specified if agent is practitioner or device
(agent.resolve().empty()) or (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()

Mappings

rim: n/a
workflow: …requester
rim: .participation[typeCode=AUT].role
w5: who.author

MedicationRequest.requester.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.requester.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.requester.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.requester.agent

Short Who ordered the initial medication(s)

Definition

The healthcare professional responsible for authorizing the initial prescription.

Cardinality 1..1

Type Reference(Device | RelatedPerson | CareConnect-GPC-Organization-1 | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1)

Summary True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: ….agent
script10.6: Message/Body/NewRx/Prescriber (need detail to link to specific prescriber … Prescriber.Identification in SCRIPT)
v2: RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)
rim: .player

MedicationRequest.requester.onBehalfOf

Short Organization agent is acting for

Definition

The organization the device or practitioner was acting on behalf of.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Summary True

Requirements

Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

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

MedicationRequest.recorder

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

Cardinality 1..1

Type Reference(CareConnect-GPC-Practitioner-1)

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

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

MedicationRequest.reasonCode

Short Reason or indication for writing the prescription

Definition

The reason or the indication for ordering the medication.

Cardinality 0..*

Condition/Problem/Diagnosis Codes (example)

A coded concept indicating why the medication was ordered.

Comments

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

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

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: …reasonCode
script10.6: Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value
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
w5: why

MedicationRequest.reasonReference

Short Condition or Observation that supports why the prescription is being written

Definition

Condition or observation that supports why the medication was ordered.

Cardinality 0..*

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

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.

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

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

MedicationRequest.note

Short Information about the prescription

Definition

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

Cardinality 0..*

Annotation

Must Support True

Comments

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

Constraints

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

Mappings

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

MedicationRequest.note.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.note.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.note.author[x]

Short Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Cardinality 0..1

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

Summary True

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

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

MedicationRequest.note.time

Short When the annotation was made

Definition

Indicates when this particular annotation was made.

Cardinality 0..1

Summary True

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

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

MedicationRequest.note.text

Short The annotation - text content

Definition

The text of the annotation.

Cardinality 1..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction

Short How the medication should be taken

Definition

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

Cardinality 1..*

Dosage

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dosageInstruction.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.sequence

Short The order of the dosage instructions

Definition

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

Cardinality 0..1

integer

Summary True

Requirements

Comments

32 bit number; for values larger than this, use 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() | (children().count() > id.count())

Mappings

rim: n/a
rim: .text

MedicationRequest.dosageInstruction.text

Short Free text dosage instructions e.g. SIG

Definition

Free text dosage instructions e.g. SIG.

Cardinality 1..1

Summary True

Requirements

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a
rim: .text

MedicationRequest.dosageInstruction.additionalInstruction

Short Supplemental instruction - e.g. "with meals"

Definition

Supplemental instruction - e.g. "with meals".

Cardinality 0..*

SNOMED CT Additional Dosage Instructions (example)

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

Summary True

Requirements

Additional instruction such as "Swallow with plenty of water" which may or may not be coded.

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dosageInstruction.additionalInstruction.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.additionalInstruction.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Summary True

Requirements

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

Comments

Unordered, Open, by system(Value)

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID

Short The SNOMED CT Description ID for the display

Definition

The SNOMED CT Description ID for the display.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.system

Short Identity of the terminology system

Definition

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

Cardinality 1..1

Summary True

Requirements

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

Comments

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

Constraints

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

Fixed Value

http://snomed.info/sct

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.display

Short Representation defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

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

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.userSelected

Short If this coding was chosen directly by the user

Definition

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

Cardinality 0..1

boolean

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

rim: n/a
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 ]

MedicationRequest.dosageInstruction.additionalInstruction.text

Short Plain text representation of the concept

Definition

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

Cardinality 0..1

Summary True

Requirements

Comments

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

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.patientInstruction

Short Patient or consumer oriented instructions

Definition

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

Cardinality 0..1

Must Support True

Summary True

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a
rim: .text

MedicationRequest.dosageInstruction.timing

Short When medication should be administered

Definition

When medication should be administered.

Cardinality 0..1

Timing

Summary True

Requirements

Comments

This attribute may 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.

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.asNeeded[x]

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

Cardinality 0..1

Type boolean | CodeableConcept

SNOMED CT Medication As Needed Reason Codes (example)

Summary True

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.site

Short Body site to administer to

Definition

Body site to administer to.

Cardinality 0..1

SNOMED CT Anatomical Structure for Administration Site Codes (example)

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

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route

Short How drug should enter body

Definition

How drug should enter body.

Cardinality 0..1

SNOMED CT Route Codes (example)

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

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dosageInstruction.route.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.route.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Summary True

Requirements

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

Comments

Unordered, Open, by system(Value)

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route.coding:snomedCT

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Care Connect Medication Dosage Route (preferred)

A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration.

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route.coding:snomedCT.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dosageInstruction.route.coding:snomedCT.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.route.coding:snomedCT.extension:snomedCTDescriptionID

Short The SNOMED CT Description ID for the display

Definition

The SNOMED CT Description ID for the display.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dosageInstruction.route.coding:snomedCT.system

Short Identity of the terminology system

Definition

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

Cardinality 1..1

Summary True

Requirements

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

Comments

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

Constraints

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

Fixed Value

http://snomed.info/sct

Mappings

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

MedicationRequest.dosageInstruction.route.coding:snomedCT.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route.coding:snomedCT.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route.coding:snomedCT.display

Short Representation defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

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

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.route.coding:snomedCT.userSelected

Short If this coding was chosen directly by the user

Definition

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

Cardinality 0..1

boolean

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

rim: n/a
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 ]

MedicationRequest.dosageInstruction.route.text

Short Plain text representation of the concept

Definition

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

Cardinality 0..1

Summary True

Requirements

Comments

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

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.method

Short Technique for administering medication

Definition

Technique for administering medication.

Cardinality 0..1

SNOMED CT Administration Method Codes (example)

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

Summary True

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.

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

Constraints

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

Mappings

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

MedicationRequest.dosageInstruction.dose[x]

Short Amount of medication per dose

Definition

Amount of medication per dose.

Cardinality 0..1

Type SimpleQuantity | Range

Summary True

Requirements

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

Comments

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

Constraints

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

Mappings

rim: n/a
rim: .doseQuantity

MedicationRequest.dosageInstruction.maxDosePerPeriod

Short Upper limit on medication per unit of time

Definition

Upper limit on medication per unit of time.

Cardinality 0..1

Ratio

Summary True

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

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
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
rim: .maxDoseQuantity

MedicationRequest.dosageInstruction.maxDosePerAdministration

Short Upper limit on medication per administration

Definition

Upper limit on medication per administration.

Cardinality 0..1

SimpleQuantity

Summary True

Requirements

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

Comments

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

Constraints

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

MedicationRequest.dosageInstruction.maxDosePerLifetime

Short Upper limit on medication per lifetime of the patient

Definition

Upper limit on medication per lifetime of the patient.

Cardinality 0..1

SimpleQuantity

Summary True

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.

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

Constraints

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

MedicationRequest.dosageInstruction.rate[x]

Short Amount of medication per unit of time

Definition

Amount of medication per unit of time.

Cardinality 0..1

Type SimpleQuantity | Range | Ratio

Summary True

Requirements

Comments

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

Constraints

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

Mappings

rim: n/a
rim: .rateQuantity

MedicationRequest.dispenseRequest

Short Medication supply authorization

Definition

Cardinality 1..1

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

Mappings

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

MedicationRequest.dispenseRequest.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dispenseRequest.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dispenseRequest.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dispenseRequest.validityPeriod

Short Time period supply is authorized for

Definition

This indicates the validity period of a prescription (stale dating the Prescription).

Cardinality 1..1

Period

Requirements

Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
script10.6: Message/Body/NewRx/MedicationPrescribed/Refills
rim: effectiveTime

MedicationRequest.dispenseRequest.validityPeriod.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dispenseRequest.validityPeriod.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dispenseRequest.validityPeriod.start

Short Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Cardinality 1..1

Summary True

Comments

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

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

Constraints

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

Mappings

rim: n/a
v2: DR.1
rim: ./low

MedicationRequest.dispenseRequest.validityPeriod.end

Short End time with inclusive boundary, if not ongoing

Definition

Cardinality 0..1

Summary True

Comments

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

Meaning when missing

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

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

Constraints

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

Mappings

rim: n/a
v2: DR.2
rim: ./high

MedicationRequest.dispenseRequest.numberOfRepeatsAllowed

Short Number of refills authorized

Definition

Cardinality 0..1

positiveInt

Comments

If displaying "number of authorized fills", add 1 to this number.

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

Constraints

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

Mappings

rim: n/a
script10.6: Message/Body/NewRx/MedicationPrescribed/Quantity
v2: RXE-12-Number of Refills
rim: repeatNumber

MedicationRequest.dispenseRequest.quantity

Short Amount of medication to supply per dispense

Definition

The amount that is to be dispensed for one fill.

Cardinality 0..1

SimpleQuantity

Must Support True

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.

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
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
script10.6: Message/Body/NewRx/MedicationPrescribed/DaysSupply
v2: RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system
rim: quantity

MedicationRequest.dispenseRequest.quantity.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dispenseRequest.quantity.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dispenseRequest.quantity.extension:quantityText

Short Quantity representation

Definition

Quantity representation.

Cardinality 0..1

Type Extension(string)

Must Support True

Alias extensions, user content

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dispenseRequest.quantity.value

Short Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Cardinality 0..1

decimal

Summary True

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

Constraints

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

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

MedicationRequest.dispenseRequest.quantity.comparator

Short < | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Cardinality 0..0

How the Quantity should be understood and represented.

QuantityComparator (required)

Modifier True

Summary True

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.

Meaning when missing

If there is no comparator, then there is no modification of the 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() | (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

MedicationRequest.dispenseRequest.quantity.unit

Short Unit representation

Definition

A human-readable form of the unit.

Cardinality 0..1

Summary True

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

MedicationRequest.dispenseRequest.quantity.system

Short System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Cardinality 0..1

Summary True

Requirements

Need to know the system that defines the coded form of the unit.

Comments

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

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

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

MedicationRequest.dispenseRequest.quantity.code

Short Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Cardinality 0..1

Summary True

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

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

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

MedicationRequest.dispenseRequest.expectedSupplyDuration

Short Number of days supply per dispense

Definition

Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

Cardinality 0..1

Duration

Must Support True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
code.exists() implies ((system = %ucum) and value.exists())

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: PQ, IVL<PQ> depending on the values
script10.6: Message/Body/NewRx/MedicationPrescribed/Substitutions
rim: expectedUseTime

MedicationRequest.dispenseRequest.expectedSupplyDuration.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.dispenseRequest.expectedSupplyDuration.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.dispenseRequest.expectedSupplyDuration.value

Short Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Cardinality 1..1

decimal

Summary True

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

Constraints

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

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator

Short < | <= | >= | > - how to understand the value

Definition

Cardinality 0..0

How the Quantity should be understood and represented.

QuantityComparator (required)

Modifier True

Summary True

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.

Meaning when missing

If there is no comparator, then there is no modification of the 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() | (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

MedicationRequest.dispenseRequest.expectedSupplyDuration.unit

Short Unit representation

Definition

A human-readable form of the unit.

Cardinality 0..1

Summary True

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

MedicationRequest.dispenseRequest.expectedSupplyDuration.system

Short System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Cardinality 1..1

Summary True

Requirements

Need to know the system that defines the coded form of the unit.

Comments

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

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

Constraints

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

Fixed Value

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

MedicationRequest.dispenseRequest.expectedSupplyDuration.code

Short Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Cardinality 1..1

A unit of time (units from UCUM).

UnitsOfTime (required)

Summary True

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

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

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

MedicationRequest.dispenseRequest.performer

Short Intended dispenser

Definition

Indicates the intended dispensing Organization specified by the prescriber.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Must Support True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
w5: who

MedicationRequest.substitution

Short Any restrictions on medication substitution

Definition

Cardinality 0..1

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

Mappings

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

MedicationRequest.substitution.id

Short xml:id (or equivalent in JSON)

Definition

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

Cardinality 0..1

Comments

Note that FHIR strings may not exceed 1MB in size

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

Constraints

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

Mappings

rim: n/a

MedicationRequest.substitution.extension

Short Additional Content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.substitution.modifierExtension

Short Extensions that cannot be ignored

Definition

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Comments

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

Constraints

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

Mappings

rim: n/a
rim: N/A

MedicationRequest.substitution.allowed

Short Whether substitution is allowed or not

Definition

True if the prescriber allows a different drug to be dispensed from what was prescribed.

Cardinality 1..1

boolean

Modifier True

Comments

This element is labeled as a modifer because whether substitution is allow or not cannot be ignored.

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

Constraints

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

Mappings

rim: n/a
script10.6: specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions
v2: RXO-9-Allow Substitutions / RXE-9-Substitution Status
rim: code

MedicationRequest.substitution.reason

Short Why should (not) substitution be made

Definition

Indicates the reason for the substitution, or why substitution must or must not be performed.

Cardinality 0..1