GP Connect Data Model | FHIR STU3 Representation

When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error.

• dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
  contained.contained.empty()
• dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
  contained.text.empty()
• dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
  contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
• dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
  contained.where(('#'+id in %resource.descendants().reference).not()).empty()
• mst-1: Reason not taken is only permitted if Taken is No
  reasonNotTaken.exists().not() or (taken = 'n')

• rim: Entity. Role, or Act
• workflow: ..Event
• rim: SubstanceAdministration
• w5: clinical.medication

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

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

• rim: n/a

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

• rim: n/a
• rim: N/A

Note that FHIR strings may not exceed 1MB in size

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

• rim: n/a

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

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

• rim: n/a
• rim: N/A

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

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

• rim: n/a

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.

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

• rim: n/a

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.

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

• rim: n/a

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.

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

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

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.

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

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

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

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

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

• rim: n/a

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

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

• rim: n/a

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

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

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

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

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

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

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

• rim: n/a
• rim: N/A

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

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

• rim: n/a
• rim: N/A

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

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

• rim: n/a
• rim: N/A

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

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

• rim: n/a
• rim: N/A

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

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

• rim: n/a
• rim: N/A

Note that FHIR strings may not exceed 1MB in size

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

• rim: n/a

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

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

• rim: n/a
• rim: N/A

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

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

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

• rim: n/a
• rim: N/A

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

• rim: n/a
• rim: N/A

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

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

• rim: n/a
• rim: N/A

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

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

Note that FHIR strings may not exceed 1MB in size

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

• rim: n/a

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

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

• rim: n/a
• rim: N/A

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

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

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

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

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

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

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

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

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

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

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

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

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

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

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

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

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

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

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

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

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

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

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

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

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

This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used.

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

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

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow: …part of
• rim: .outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]

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

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

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow: …context
• rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]

MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error).

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

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

• rim: n/a
• workflow: …status
• rim: .statusCode
• w5: status

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

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

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication usage"].value
• w5: class

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

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

• rim: n/a
• workflow: …code
• rim: .participation[typeCode=CSM].role[classCode=ADMM or MANU]
• w5: what

This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted.

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

• rim: n/a
• workflow: …occurrence[x]
• rim: .effectiveTime
• w5: when.done

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

• rim: n/a
• rim: .participation[typeCode=AUT].time
• w5: when.recorded

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

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

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• rim: .participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)
• w5: who.source

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

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

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• workflow: …subject
• v2: PID-3-Patient ID List
• rim: .participation[typeCode=SBJ].role[classCode=PAT]
• w5: who

Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.

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

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• rim: .outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]

This element is labeled as a modifier because it indicates that the medication was not taken.

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

• rim: n/a
• workflow: …notDone
• rim: .actionNegationInd

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

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

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• rim: .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="reason not taken"].value

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

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

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• workflow: …reasoneCodeableConcept
• rim: .reasonCode
• w5: why

This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.

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