GP Connect - Update Record (ITK3)

Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message.

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

• rim:Entity. Role, or Act
• rim:Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
• w5:infrastructure.exchange

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

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

• rim:n/a

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

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

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

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

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

• rim:n/a

A human language.

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

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

• rim:n/a

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

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

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

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

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

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

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

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

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

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

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

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

• rim:n/a
• v2:ERR
• rim:AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a

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

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

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

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

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

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

How the issue affects the success of the action.

Indicates how relevant the issue is to the overall success of the action.

This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

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

• rim:n/a
• v2:ERR-4
• rim:./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode="OBS" and moodCode="EVN" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type="CD"]

A code that describes the type of issue.

Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

Note that FHIR strings may not exceed 1MB in size

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

• rim:n/a
• v2:ERR-3
• rim:./code

A ValueSet that provides details as to the exact issue.

A human readable description of the response issue SHOULD be placed in details.text.

• 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:ERR-5
• rim:./code

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 for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

• 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
• v2:C*E.1-8, C*E.10-22
• rim:union(., ./translation)
• orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

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

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

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

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

https://fhir.nhs.uk/STU3/CodeSystem/ITK-ResponseCodes-1

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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

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

Need to refer to a particular code in the system.

Note that FHIR strings may not exceed 1MB in size

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

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

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

Note that FHIR strings may not exceed 1MB in size

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

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

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.

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

• 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 ]

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

• 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

Typically this field is used to provide troubleshooting information about the error.

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

• rim:n/a
• v2:ERR-8
• rim:./text[parent::AcknowledgmentDetail]

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON. Note that expression is being trialed as an alternative to XPath.

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

• rim:n/a
• v2:ERR-2
• rim:./location[parent::AcknowledgmentDetail]

Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

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

• rim:n/a
• v2:ERR-2
• rim:./location[parent::AcknowledgmentDetail]