Profile: CareConnect-GPC-List-1
CareConnect-GPC-List-1 (List) | I | List | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
profile | Σ | 1..* | uri |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | I | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
clinicalSetting | S I | 0..1 | Extension(CodeableConcept) |
warningCode | S I | 0..* | Extension(code) |
relatedProblemHeader | S I | 0..* | Extension(Complex) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
type | I | 0..* | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
valueCode | 0..1 | codeBinding | |
target | I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
valueReference | 0..1 | Reference(CareConnect-ProblemHeader-Condition-1) | |
url | 1..1 | uriFixed Value | |
value[x] | 0..0 | ||
modifierExtension | ?! I | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(CareConnect-GPC-Organization-1) |
status | Σ ?! | 1..1 | codeBindingFixed Value |
mode | Σ ?! | 1..1 | codeBindingFixed Value |
title | Σ | 0..1 | string |
code | Σ | 1..1 | CodeableConceptBinding |
subject | Σ I | 1..1 | Reference(Group | Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Location-1) |
encounter | I | 0..1 | Reference(CareConnect-GPC-Encounter-1) |
date | Σ | 0..1 | dateTime |
source | Σ I | 0..1 | Reference(Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) |
orderedBy | 0..1 | CodeableConceptBinding | |
note | S | 0..* | Annotation |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(RelatedPerson | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
entry | S I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
flag | 0..1 | CodeableConcept | |
deleted | ?! I | 0..1 | boolean |
date | 0..1 | dateTime | |
item | I | 1..1 | Reference(Resource) |
emptyReason | S I | 0..1 | CodeableConceptBinding |
List | |
Definition | A set of information summarized from a list of other resources. |
Cardinality | 0...* |
Alias | Collection, WorkingList, Organizer |
Invariants |
|
Mappings |
|
List.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Invariants |
|
Mappings |
|
List.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
List.meta.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.meta.versionId | |
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 |
Type | id |
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. |
Invariants |
|
Mappings |
|
List.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | 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. |
Invariants |
|
Mappings |
|
List.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](). |
Cardinality | 1...* |
Type | uri |
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. |
Invariants |
|
Mappings |
|
List.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) |
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. |
Invariants |
|
Mappings |
|
List.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...* |
Type | Coding |
Binding | 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. |
Invariants |
|
Mappings |
|
List.implicitRules | |
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 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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. |
Invariants |
|
Mappings |
|
List.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. Common Languages (extensible) |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
List.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
Invariants |
|
Mappings |
|
List.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | 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 |
|
List.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.extension:clinicalSetting | |
Definition | To record the clinical setting of a problem list. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
List.extension:warningCode | |
Definition | To capture warnings that the list may be incomplete. |
Cardinality | 0...* |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader | |
Definition | A reference to any related problems. |
Cardinality | 0...* |
Type | Extension(Complex) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:type | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:type.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | 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. |
Invariants |
|
Fixed Value | type |
Mappings |
|
List.extension:relatedProblemHeader.extension:type.value[x]:valueCode | |
Definition | Condition relationship type. |
Cardinality | 0...1 |
Type | code |
Binding | A set of codes specifying the kind of relationship that exists with a target problem header condition. Care Connect Condition Relationship (required) |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:target | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 1...1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:target.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:target.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.extension:target.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | 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. |
Invariants |
|
Fixed Value | target |
Mappings |
|
List.extension:relatedProblemHeader.extension:target.value[x]:valueReference | |
Definition | Target problem header condition. |
Cardinality | 0...1 |
Type | Reference(CareConnect-ProblemHeader-Condition-1) |
Invariants |
|
Mappings |
|
List.extension:relatedProblemHeader.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | 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. |
Invariants |
|
Fixed Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1 |
Mappings |
|
List.extension:relatedProblemHeader.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Cardinality | 0...0 |
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta |
Invariants |
|
Mappings |
|
List.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.identifier | |
Definition | Identifier for the List assigned for business purposes outside the context of FHIR. |
Cardinality | 0...* |
Type | Identifier |
Invariants |
|
Mappings |
|
List.identifier.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | 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 | 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. |
Invariants |
|
Mappings |
|
List.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | 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. |
Invariants |
|
Mappings |
|
List.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
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 |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
List.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
List.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
List.identifier.assigner | |
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. |
Invariants |
|
Mappings |
|
List.status | |
Definition | Indicates the current state of this list. |
Cardinality | 1...1 |
Type | code |
Binding | The current state of the list ListStatus (required) |
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. |
Invariants |
|
Fixed Value | current |
Mappings |
|
List.mode | |
Definition | How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Cardinality | 1...1 |
Type | code |
Binding | The processing mode that applies to this list ListMode (required) |
Modifier | True |
Summary | True |
Requirements | Lists are used in various ways, and it must be known in what way it is safe to use them. |
Comments | This element is labeled as a modifier because a change list must not be mis-understood as a complete list. |
Invariants |
|
Fixed Value | snapshot |
Mappings |
|
List.title | |
Definition | A label for the list assigned by the author. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Allows customization beyond just the code identifying the kind of list. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Examples | General Dr. Jane's Patients |
Mappings |
|
List.code | |
Definition | This code defines the purpose of the list - why it was created. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | What the purpose of a list is Care Connect List Code (extensible) |
Summary | True |
Requirements | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. |
Comments | If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code. |
Invariants |
|
Mappings |
|
List.subject | |
Definition | The common subject (or patient) of the resources that are in the list, if there is one. |
Cardinality | 1...1 |
Type | Reference(Group | Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Location-1) |
Summary | True |
Requirements | The primary purpose of listing the subject explicitly is to help with finding the right list. |
Comments | Some purely arbitrary lists do not have a common subject, so this is optional. |
Invariants |
|
Mappings |
|
List.encounter | |
Definition | The encounter that is the context in which this list was created. |
Cardinality | 0...1 |
Type | Reference(CareConnect-GPC-Encounter-1) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
List.date | |
Definition | The date that the list was prepared. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Requirements | Identifies how current the list is which affects relevance. |
Comments | The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs. |
Invariants |
|
Mappings |
|
List.source | |
Definition | The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
Cardinality | 0...1 |
Type | Reference(Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) |
Summary | True |
Alias | Author |
Requirements | Allows follow-up as well as context. |
Comments | The primary source is the entity that made the decisions what items are in the list. This may be software or user. |
Invariants |
|
Mappings |
|
List.orderedBy | |
Definition | What order applies to the items in the list. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | What order applies to the items in a list List Order Codes (preferred) |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
Invariants |
|
Mappings |
|
List.note | |
Definition | Comments that apply to the overall list. |
Cardinality | 0...* |
Type | Annotation |
Must Support | True |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
List.note.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.note.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.note.author[x] | |
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 |
Invariants |
|
Mappings |
|
List.note.time | |
Definition | Indicates when this particular annotation was made. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
List.note.text | |
Definition | The text of the annotation. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.entry | |
Definition | Entries in this list. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants |
|
Mappings |
|
List.entry.id | |
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 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
List.entry.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
List.entry.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
List.entry.flag | |
Definition | The flag allows the system constructing the list to indicate the role and significance of the item in the list. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes that provide further information about the reason and meaning of the item in the list Patient Medicine Change Types (example) |
Requirements | This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list. |
Comments | The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes". |
Invariants |
|
Mappings |
|
List.entry.deleted | |
Definition | True if this item is marked as deleted in the list. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Requirements | The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted". |
Comments | If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list. |
Invariants |
|
Mappings |
|
List.entry.date | |
Definition | When this item was added to the list. |
Cardinality | 0...1 |
Type | dateTime |
Requirements | The date may be significant for understanding the meaning of items in a working list. |
Comments | This is only useful and meaningful when the mode is "working". |
Invariants |
|
Mappings |
|
List.entry.item | |
Definition | A reference to the actual resource from which data was derived. |
Cardinality | 1...1 |
Type | Reference(Resource) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
List.emptyReason | |
Definition | If the list is empty, why the list is empty. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | If a list is empty, why it is empty Care Connect List Empty Reason Code (required) |
Must Support | True |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <meta> <lastUpdated value="2018-05-10T15:25:35.853+01:00" /> </meta> <url value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-List-1" /> <version value="1.7.0" /> <name value="CareConnect-GPC-List-1" /> <status value="active" /> <date value="2020-04-09" /> <publisher value="HL7 UK" /> <contact> <name value="INTEROPen" /> <telecom> <system value="email" /> <value value="admin@interopen.org" /> <use value="work" /> </telecom> </contact> <description value="The List resource is a flat, possibly ordered collection of records. List resources are used in many places, including allergies, medications, alerts, family history, medical history, etc. List resources can be used to support patient-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc." /> <purpose value="CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/" /> <copyright value="Copyright © 2020 HL7 UK\n\nLicensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html" /> <fhirVersion value="3.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="List" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/List" /> <derivation value="constraint" /> <snapshot> <element id="List"> <path value="List" /> <short value="Information summarized from a list of other resources" /> <definition value="A set of information summarized from a list of other resources." /> <alias value="Collection" /> <alias value="WorkingList" /> <alias value="Organizer" /> <min value="0" /> <max value="*" /> <base> <path value="Resource" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> </constraint> <constraint> <key value="dom-1" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative" /> <expression value="contained.text.empty()" /> <xpath value="not(parent::f:contained and f:text)" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource" /> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()" /> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" /> </constraint> <constraint> <key value="lst-2" /> <severity value="error" /> <human value="The deleted flag can only be used if the mode of the list is "changes"" /> <expression value="mode = 'changes' or entry.deleted.empty()" /> <xpath value="(f:mode/@value = 'changes') or not(exists(f:entry/f:deleted))" /> </constraint> <constraint> <key value="lst-1" /> <severity value="error" /> <human value="A list can only have an emptyReason if it is empty" /> <expression value="emptyReason.empty() or entry.empty()" /> <xpath value="not(exists(f:emptyReason) and exists(f:entry))" /> </constraint> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="Act[classCode<ORG,moodCode=EVN]" /> </mapping> <mapping> <identity value="w5" /> <map value="infrastructure.documents" /> </mapping> </element> <element id="List.id"> <path value="List.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="id" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.meta"> <path value="List.meta" /> <short value="Metadata about the resource" /> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.meta.id"> <path value="List.meta.id" /> <representation value="xmlAttr" /> <short value="xml:id (or equivalent in JSON)" /> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.meta.extension"> <path value="List.meta.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.meta.versionId"> <path value="List.meta.versionId" /> <short value="Version specific identifier" /> <definition value="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." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Meta.versionId" /> <min value="0" /> <max value="1" /> </base> <type> <code value="id" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.meta.lastUpdated"> <path value="List.meta.lastUpdated" /> <short value="When the resource version last changed" /> <definition value="When the resource last changed - e.g. when the version changed." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Meta.lastUpdated" /> <min value="0" /> <max value="1" /> </base> <type> <code value="instant" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.meta.profile"> <path value="List.meta.profile" /> <short value="Profiles this resource claims to conform to" /> <definition value="A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url]()." /> <comment value="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." /> <min value="1" /> <max value="*" /> <base> <path value="Meta.profile" /> <min value="0" /> <max value="*" /> </base> <type> <code value="uri" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.meta.security"> <path value="List.meta.security" /> <short value="Security Labels applied to this resource" /> <definition value="Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure." /> <comment value="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." /> <min value="0" /> <max value="*" /> <base> <path value="Meta.security" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SecurityLabels" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="extensible" /> <description value="Security Labels from the Healthcare Privacy and Security Classification System." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/security-labels" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" /> </mapping> <mapping> <identity value="rim" /> <map value="CV" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding rdfs:subClassOf dt:CDCoding" /> </mapping> </element> <element id="List.meta.tag"> <path value="List.meta.tag" /> <short value="Tags applied to this resource" /> <definition value="Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource." /> <comment value="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." /> <min value="0" /> <max value="*" /> <base> <path value="Meta.tag" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Tags" /> </extension> <strength value="example" /> <description value="Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"" /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/common-tags" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" /> </mapping> <mapping> <identity value="rim" /> <map value="CV" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding rdfs:subClassOf dt:CDCoding" /> </mapping> </element> <element id="List.implicitRules"> <path value="List.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content." /> <comment value="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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.language"> <path value="List.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="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)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages" /> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="extensible" /> <description value="A human language." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.text"> <path value="List.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." /> <comment value="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." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <condition value="ele-1" /> <condition value="dom-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="List.contained"> <path value="List.contained" /> <short value="Contained, inline Resources" /> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." /> <comment value="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." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension"> <path value="List.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension:clinicalSetting"> <path value="List.extension" /> <sliceName value="clinicalSetting" /> <short value="To record the clinical setting of a problem list" /> <definition value="To record the clinical setting of a problem list." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension:warningCode"> <path value="List.extension" /> <sliceName value="warningCode" /> <short value="To capture warnings that the list may be incomplete" /> <definition value="To capture warnings that the list may be incomplete." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ListWarningCode-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension:relatedProblemHeader"> <path value="List.extension" /> <sliceName value="relatedProblemHeader" /> <short value="A reference to any related problems" /> <definition value="A reference to any related problems." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension:relatedProblemHeader.id"> <path value="List.extension.id" /> <representation value="xmlAttr" /> <short value="xml:id (or equivalent in JSON)" /> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.extension:relatedProblemHeader.extension"> <path value="List.extension.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension:relatedProblemHeader.url"> <path value="List.extension.url" /> <representation value="xmlAttr" /> <short value="identifies the meaning of the extension" /> <definition value="Source of the definition for the extension code - a logical name or a URL." /> <comment value="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." /> <min value="1" /> <max value="1" /> <base> <path value="Extension.url" /> <min value="1" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" /> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.extension:relatedProblemHeader.value[x]"> <path value="List.extension.value[x]" /> <short value="Value of extension" /> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)." /> <comment value="A stream of bytes, base64 encoded" /> <min value="0" /> <max value="1" /> <base> <path value="Extension.value[x]" /> <min value="0" /> <max value="1" /> </base> <type> <code value="base64Binary" /> </type> <type> <code value="boolean" /> </type> <type> <code value="code" /> </type> <type> <code value="date" /> </type> <type> <code value="dateTime" /> </type> <type> <code value="decimal" /> </type> <type> <code value="id" /> </type> <type> <code value="instant" /> </type> <type> <code value="integer" /> </type> <type> <code value="markdown" /> </type> <type> <code value="oid" /> </type> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <type> <code value="time" /> </type> <type> <code value="unsignedInt" /> </type> <type> <code value="uri" /> </type> <type> <code value="Address" /> </type> <type> <code value="Age" /> </type> <type> <code value="Annotation" /> </type> <type> <code value="Attachment" /> </type> <type> <code value="CodeableConcept" /> </type> <type> <code value="Coding" /> </type> <type> <code value="ContactPoint" /> </type> <type> <code value="Count" /> </type> <type> <code value="Distance" /> </type> <type> <code value="Duration" /> </type> <type> <code value="HumanName" /> </type> <type> <code value="Identifier" /> </type> <type> <code value="Money" /> </type> <type> <code value="Period" /> </type> <type> <code value="Quantity" /> </type> <type> <code value="Range" /> </type> <type> <code value="Ratio" /> </type> <type> <code value="Reference" /> </type> <type> <code value="SampledData" /> </type> <type> <code value="Signature" /> </type> <type> <code value="Timing" /> </type> <type> <code value="Meta" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.modifierExtension"> <path value="List.modifierExtension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Extensions that cannot be ignored" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <isModifier value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.identifier"> <path value="List.identifier" /> <short value="Business identifier" /> <definition value="Identifier for the List assigned for business purposes outside the context of FHIR." /> <min value="0" /> <max value="*" /> <base> <path value="List.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" /> </mapping> <mapping> <identity value="rim" /> <map value="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]" /> </mapping> <mapping> <identity value="servd" /> <map value="Identifier" /> </mapping> <mapping> <identity value="rim" /> <map value=".id" /> </mapping> <mapping> <identity value="w5" /> <map value="id" /> </mapping> </element> <element id="List.identifier.id"> <path value="List.identifier.id" /> <representation value="xmlAttr" /> <short value="xml:id (or equivalent in JSON)" /> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.identifier.extension"> <path value="List.identifier.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.identifier.use"> <path value="List.identifier.use" /> <short value="usual | official | temp | secondary (If known)" /> <definition value="The purpose of this identifier." /> <comment value="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." /> <requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers." /> <min value="0" /> <max value="1" /> <base> <path value="Identifier.use" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IdentifierUse" /> </extension> <strength value="required" /> <description value="Identifies the purpose for this identifier, if known ." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-use" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Role.code or implied by context" /> </mapping> </element> <element id="List.identifier.type"> <path value="List.identifier.type" /> <short value="Description of identifier" /> <definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." /> <comment value="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. \n\nWhere 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." /> <requirements value="Allows users to make use of identifiers when the identifier system is not known." /> <min value="0" /> <max value="1" /> <base> <path value="Identifier.type" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IdentifierType" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="extensible" /> <description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-type" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="v2" /> <map value="CX.5" /> </mapping> <mapping> <identity value="rim" /> <map value="Role.code or implied by context" /> </mapping> </element> <element id="List.identifier.system"> <path value="List.identifier.system" /> <short value="The namespace for the identifier value" /> <definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique." /> <comment value="see http://en.wikipedia.org/wiki/Uniform_resource_identifier" /> <requirements value="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." /> <min value="1" /> <max value="1" /> <base> <path value="Identifier.system" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <example> <label value="General" /> <valueUri value="http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" /> </example> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CX.4 / EI-2-4" /> </mapping> <mapping> <identity value="rim" /> <map value="II.root or Role.id.root" /> </mapping> <mapping> <identity value="servd" /> <map value="./IdentifierType" /> </mapping> </element> <element id="List.identifier.value"> <path value="List.identifier.value" /> <short value="The value that is unique" /> <definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." /> <comment value="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](extension-rendered-value.html)." /> <min value="1" /> <max value="1" /> <base> <path value="Identifier.value" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <example> <label value="General" /> <valueString value="123456" /> </example> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CX.1 / EI.1" /> </mapping> <mapping> <identity value="rim" /> <map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" /> </mapping> <mapping> <identity value="servd" /> <map value="./Value" /> </mapping> </element> <element id="List.identifier.period"> <path value="List.identifier.period" /> <short value="Time period when id is/was valid for use" /> <definition value="Time period during which identifier is/was valid for use." /> <comment 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." /> <min value="0" /> <max value="1" /> <base> <path value="Identifier.period" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="per-1" /> <severity value="error" /> <human value="If present, start SHALL have a lower value than end" /> <expression value="start.empty() or end.empty() or (start <= end)" /> <xpath value="not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="DR" /> </mapping> <mapping> <identity value="rim" /> <map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" /> </mapping> <mapping> <identity value="v2" /> <map value="CX.7 + CX.8" /> </mapping> <mapping> <identity value="rim" /> <map value="Role.effectiveTime or implied by context" /> </mapping> <mapping> <identity value="servd" /> <map value="./StartDate and ./EndDate" /> </mapping> </element> <element id="List.identifier.assigner"> <path value="List.identifier.assigner" /> <short value="Organization that issued id (may be just text)" /> <definition value="Organization that issued/manages the identifier." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Identifier.assigner" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="v2" /> <map value="CX.4 / (CX.4,CX.9,CX.10)" /> </mapping> <mapping> <identity value="rim" /> <map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" /> </mapping> <mapping> <identity value="servd" /> <map value="./IdentifierIssuingAuthority" /> </mapping> </element> <element id="List.status"> <path value="List.status" /> <short value="current | retired | entered-in-error" /> <definition value="Indicates the current state of this list." /> <comment value="This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid." /> <min value="1" /> <max value="1" /> <base> <path value="List.status" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> <fixedCode value="current" /> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListStatus" /> </extension> <strength value="required" /> <description value="The current state of the list" /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/list-status" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value=".status[current=active;retired=obsolete;entered-in-error=nullified]" /> </mapping> <mapping> <identity value="w5" /> <map value="status" /> </mapping> </element> <element id="List.mode"> <path value="List.mode" /> <short value="working | snapshot | changes" /> <definition value="How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted." /> <comment value="This element is labeled as a modifier because a change list must not be mis-understood as a complete list." /> <requirements value="Lists are used in various ways, and it must be known in what way it is safe to use them." /> <min value="1" /> <max value="1" /> <base> <path value="List.mode" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> <fixedCode value="snapshot" /> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListMode" /> </extension> <strength value="required" /> <description value="The processing mode that applies to this list" /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/list-mode" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value=".outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value" /> </mapping> <mapping> <identity value="w5" /> <map value="class" /> </mapping> </element> <element id="List.title"> <path value="List.title" /> <short value="Descriptive name for the list" /> <definition value="A label for the list assigned by the author." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <requirements value="Allows customization beyond just the code identifying the kind of list." /> <min value="0" /> <max value="1" /> <base> <path value="List.title" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <example> <label value="General" /> <valueString value="Dr. Jane's Patients" /> </example> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value=".title" /> </mapping> </element> <element id="List.code"> <path value="List.code" /> <short value="What the purpose of this list is" /> <definition value="This code defines the purpose of the list - why it was created." /> <comment value="If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code." /> <requirements value="Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included." /> <min value="1" /> <max value="1" /> <base> <path value="List.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListPurpose" /> </extension> <strength value="extensible" /> <description value="What the purpose of a list is" /> <valueSetReference> <reference value="https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ListCode-1" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="rim" /> <map value=".code" /> </mapping> <mapping> <identity value="w5" /> <map value="what" /> </mapping> </element> <element id="List.subject"> <path value="List.subject" /> <short value="If all resources have the same subject" /> <definition value="The common subject (or patient) of the resources that are in the list, if there is one." /> <comment value="Some purely arbitrary lists do not have a common subject, so this is optional." /> <requirements value="The primary purpose of listing the subject explicitly is to help with finding the right list." /> <min value="1" /> <max value="1" /> <base> <path value="List.subject" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" /> </type> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode<SUB].role (and sometimes .player)" /> </mapping> <mapping> <identity value="w5" /> <map value="who.focus" /> </mapping> </element> <element id="List.encounter"> <path value="List.encounter" /> <short value="Context in which list created" /> <definition value="The encounter that is the context in which this list was created." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="List.encounter" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="rim" /> <map value="inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" /> </mapping> <mapping> <identity value="w5" /> <map value="context" /> </mapping> </element> <element id="List.date"> <path value="List.date" /> <short value="When the list was prepared" /> <definition value="The date that the list was prepared." /> <comment value="The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs." /> <requirements value="Identifies how current the list is which affects relevance." /> <min value="0" /> <max value="1" /> <base> <path value="List.date" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode<AUT].time[type=TS]" /> </mapping> <mapping> <identity value="w5" /> <map value="when.recorded" /> </mapping> </element> <element id="List.source"> <path value="List.source" /> <short value="Who and/or what defined the list contents (aka Author)" /> <definition value="The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list." /> <comment value="The primary source is the entity that made the decisions what items are in the list. This may be software or user." /> <requirements value="Allows follow-up as well as context." /> <alias value="Author" /> <min value="0" /> <max value="1" /> <base> <path value="List.source" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]" /> </mapping> <mapping> <identity value="w5" /> <map value="who.author" /> </mapping> </element> <element id="List.orderedBy"> <path value="List.orderedBy" /> <short value="What order the list has" /> <definition value="What order applies to the items in the list." /> <comment value="Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order." /> <requirements value="Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries." /> <min value="0" /> <max value="1" /> <base> <path value="List.orderedBy" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListOrder" /> </extension> <strength value="preferred" /> <description value="What order applies to the items in a list" /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/list-order" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="rim" /> <map value=".outboundRelationship[typeCode=COMP].sequenceNumber > 1" /> </mapping> </element> <element id="List.note"> <path value="List.note" /> <short value="Comments about the list" /> <definition value="Comments that apply to the overall list." /> <comment value="For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible)." /> <min value="0" /> <max value="*" /> <base> <path value="List.note" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Annotation" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act" /> </mapping> <mapping> <identity value="rim" /> <map value=".inboundRelationship[typeCode=SUBJ].act.text" /> </mapping> </element> <element id="List.note.id"> <path value="List.note.id" /> <representation value="xmlAttr" /> <short value="xml:id (or equivalent in JSON)" /> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.note.extension"> <path value="List.note.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.note.author[x]"> <path value="List.note.author[x]" /> <short value="Individual responsible for the annotation" /> <definition value="The individual responsible for making the annotation." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Annotation.author[x]" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> </type> <type> <code value="string" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.participant[typeCode=AUT].role" /> </mapping> </element> <element id="List.note.time"> <path value="List.note.time" /> <short value="When the annotation was made" /> <definition value="Indicates when this particular annotation was made." /> <min value="0" /> <max value="1" /> <base> <path value="Annotation.time" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.effectiveTime" /> </mapping> </element> <element id="List.note.text"> <path value="List.note.text" /> <short value="The annotation - text content" /> <definition value="The text of the annotation." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="1" /> <max value="1" /> <base> <path value="Annotation.text" /> <min value="1" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.text" /> </mapping> </element> <element id="List.entry"> <path value="List.entry" /> <short value="Entries in the list" /> <definition value="Entries in this list." /> <comment value="If there are no entries in the list, an emptyReason SHOULD be provided." /> <min value="0" /> <max value="*" /> <base> <path value="List.entry" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <condition value="ele-1" /> <condition value="lst-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mustSupport value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value=".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" /> </mapping> </element> <element id="List.entry.id"> <path value="List.entry.id" /> <representation value="xmlAttr" /> <short value="xml:id (or equivalent in JSON)" /> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <comment value="Note that FHIR strings may not exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="List.entry.extension"> <path value="List.entry.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional Content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.entry.modifierExtension"> <path value="List.entry.modifierExtension" /> <short value="Extensions that cannot be ignored" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> </constraint> <isModifier value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="List.entry.flag"> <path value="List.entry.flag" /> <short value="Status/Workflow information about this item" /> <definition value="The flag allows the system constructing the list to indicate the role and significance of the item in the list." /> <comment value="The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes"." /> <requirements value="This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list." /> <min value="0" /> <max value="1" /> <base> <path value="List.entry.flag" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListItemFlag" /> </extension> <strength value="example" /> <description value="Codes that provide further information about the reason and meaning of the item in the list" /> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/list-item-flag" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="rim" /> <map value=".outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value" /> </mapping> </element> <element id="List.entry.deleted"> <path value="List.entry.deleted" /> <short value="If this item is actually marked as deleted" /> <definition value="True if this item is marked as deleted in the list." /> <comment value="If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted.\n\nThis element is labeled as a modifier because it indicates that an item is (to be) no longer in the list." /> <requirements value="The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted"." /> <min value="0" /> <max value="1" /> <base> <path value="List.entry.deleted" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <defaultValueBoolean value="false" /> <condition value="ele-1" /> <condition value="lst-2" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <isModifier value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"" /> </mapping> </element> <element id="List.entry.date"> <path value="List.entry.date" /> <short value="When item added to list" /> <definition value="When this item was added to the list." /> <comment value="This is only useful and meaningful when the mode is "working"." /> <requirements value="The date may be significant for understanding the meaning of items in a working list." /> <min value="0" /> <max value="1" /> <base> <path value="List.entry.date" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value=".availabilityTime" /> </mapping> </element> <element id="List.entry.item"> <path value="List.entry.item" /> <short value="Actual entry" /> <definition value="A reference to the actual resource from which data was derived." /> <comment value="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." /> <min value="1" /> <max value="1" /> <base> <path value="List.entry.item" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="rim" /> <map value=".target or .role or .role.entity" /> </mapping> </element> <element id="List.emptyReason"> <path value="List.emptyReason" /> <short value="Why list is empty" /> <definition value="If the list is empty, why the list is empty." /> <comment value="The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases." /> <requirements value="Allows capturing things like "none exist" or "not asked" which can be important for most lists." /> <min value="0" /> <max value="1" /> <base> <path value="List.emptyReason" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <condition value="lst-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() | (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> </constraint> <mustSupport value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListEmptyReason" /> </extension> <strength value="required" /> <description value="If a list is empty, why it is empty" /> <valueSetReference> <reference value="https://fhir.nhs.uk/STU3/ValueSet/CareConnect-ListEmptyReasonCode-1" /> </valueSetReference> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="rim" /> <map value=".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]" /> </mapping> </element> </snapshot> <differential> <element id="List.meta.profile"> <path value="List.meta.profile" /> <min value="1" /> </element> <element id="List.extension"> <path value="List.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="List.extension:clinicalSetting"> <path value="List.extension" /> <sliceName value="clinicalSetting" /> <type> <code value="Extension" /> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" /> </type> <mustSupport value="true" /> </element> <element id="List.extension:warningCode"> <path value="List.extension" /> <sliceName value="warningCode" /> <type> <code value="Extension" /> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ListWarningCode-1" /> </type> <mustSupport value="true" /> </element> <element id="List.extension:relatedProblemHeader"> <path value="List.extension" /> <sliceName value="relatedProblemHeader" /> <short value="A reference to any related problems" /> <definition value="A reference to any related problems." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" /> </type> <mustSupport value="true" /> </element> <element id="List.extension:relatedProblemHeader.url"> <path value="List.extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" /> </element> <element id="List.identifier.system"> <path value="List.identifier.system" /> <min value="1" /> </element> <element id="List.identifier.value"> <path value="List.identifier.value" /> <min value="1" /> </element> <element id="List.identifier.assigner"> <path value="List.identifier.assigner" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" /> </type> </element> <element id="List.status"> <path value="List.status" /> <fixedCode value="current" /> </element> <element id="List.mode"> <path value="List.mode" /> <fixedCode value="snapshot" /> </element> <element id="List.code"> <path value="List.code" /> <min value="1" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListPurpose" /> </extension> <strength value="extensible" /> <valueSetReference> <reference value="https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ListCode-1" /> </valueSetReference> </binding> </element> <element id="List.subject"> <path value="List.subject" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" /> </type> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1" /> </type> </element> <element id="List.encounter"> <path value="List.encounter" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1" /> </type> </element> <element id="List.source"> <path value="List.source" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" /> </type> </element> <element id="List.note"> <path value="List.note" /> <mustSupport value="true" /> </element> <element id="List.note.author[x]"> <path value="List.note.author[x]" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> </type> <type> <code value="string" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" /> </type> <type> <code value="Reference" /> <targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" /> </type> </element> <element id="List.entry"> <path value="List.entry" /> <mustSupport value="true" /> </element> <element id="List.emptyReason"> <path value="List.emptyReason" /> <mustSupport value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ListEmptyReason" /> </extension> <strength value="required" /> <valueSetReference> <reference value="https://fhir.nhs.uk/STU3/ValueSet/CareConnect-ListEmptyReasonCode-1" /> </valueSetReference> </binding> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "meta": { "lastUpdated": "2018-05-10T15:25:35.853+01:00" }, "url": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-List-1", "version": "1.7.0", "name": "CareConnect-GPC-List-1", "status": "active", "date": "2020-04-09", "publisher": "HL7 UK", "contact": [ { "name": "INTEROPen", "telecom": [ { "system": "email", "value": "admin@interopen.org", "use": "work" } ] } ], "description": "The List resource is a flat, possibly ordered collection of records. List resources are used in many places, including allergies, medications, alerts, family history, medical history, etc. List resources can be used to support patient-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc.", "purpose": "CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/", "copyright": "Copyright © 2020 HL7 UK\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html", "fhirVersion": "3.0.1", "kind": "resource", "abstract": false, "type": "List", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/List", "derivation": "constraint", "snapshot": { "element": [ { "id": "List", "path": "List", "short": "Information summarized from a list of other resources", "definition": "A set of information summarized from a list of other resources.", "alias": [ "Collection", "WorkingList", "Organizer" ], "min": 0, "max": "*", "base": { "path": "Resource", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" }, { "key": "lst-2", "severity": "error", "human": "The deleted flag can only be used if the mode of the list is \"changes\"", "expression": "mode = 'changes' or entry.deleted.empty()", "xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:deleted))" }, { "key": "lst-1", "severity": "error", "human": "A list can only have an emptyReason if it is empty", "expression": "emptyReason.empty() or entry.empty()", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Act[classCode<ORG,moodCode=EVN]" }, { "identity": "w5", "map": "infrastructure.documents" } ] }, { "id": "List.id", "path": "List.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.meta", "path": "List.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.meta.id", "path": "List.meta.id", "representation": [ "xmlAttr" ], "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.meta.extension", "path": "List.meta.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.meta.versionId", "path": "List.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.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Meta.versionId", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.meta.lastUpdated", "path": "List.meta.lastUpdated", "short": "When the resource version last changed", "definition": "When the resource last changed - e.g. when the version changed.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Meta.lastUpdated", "min": 0, "max": "1" }, "type": [ { "code": "instant" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.meta.profile", "path": "List.meta.profile", "short": "Profiles this resource claims to conform to", "definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url]().", "comment": "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.", "min": 1, "max": "*", "base": { "path": "Meta.profile", "min": 0, "max": "*" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.meta.security", "path": "List.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.", "comment": "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.", "min": 0, "max": "*", "base": { "path": "Meta.security", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" } ] }, { "id": "List.meta.tag", "path": "List.meta.tag", "short": "Tags applied to this resource", "definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "comment": "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.", "min": 0, "max": "*", "base": { "path": "Meta.tag", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Tags" } ], "strength": "example", "description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/common-tags" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" } ] }, { "id": "List.implicitRules", "path": "List.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.", "comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.language", "path": "List.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.text", "path": "List.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "List.contained", "path": "List.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension", "path": "List.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension:clinicalSetting", "path": "List.extension", "sliceName": "clinicalSetting", "short": "To record the clinical setting of a problem list", "definition": "To record the clinical setting of a problem list.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension:warningCode", "path": "List.extension", "sliceName": "warningCode", "short": "To capture warnings that the list may be incomplete", "definition": "To capture warnings that the list may be incomplete.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ListWarningCode-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension:relatedProblemHeader", "path": "List.extension", "sliceName": "relatedProblemHeader", "short": "A reference to any related problems", "definition": "A reference to any related problems.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension:relatedProblemHeader.id", "path": "List.extension.id", "representation": [ "xmlAttr" ], "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.extension:relatedProblemHeader.extension", "path": "List.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension:relatedProblemHeader.url", "path": "List.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.extension:relatedProblemHeader.value[x]", "path": "List.extension.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).", "comment": "A stream of bytes, base64 encoded", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.modifierExtension", "path": "List.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.identifier", "path": "List.identifier", "short": "Business identifier", "definition": "Identifier for the List assigned for business purposes outside the context of FHIR.", "min": 0, "max": "*", "base": { "path": "List.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "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]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "List.identifier.id", "path": "List.identifier.id", "representation": [ "xmlAttr" ], "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.identifier.extension", "path": "List.identifier.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.identifier.use", "path": "List.identifier.use", "short": "usual | official | temp | secondary (If known)", "definition": "The purpose of this identifier.", "comment": "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.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "List.identifier.type", "path": "List.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.", "comment": "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. \n\nWhere 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.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-type" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "List.identifier.system", "path": "List.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.", "comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", "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.", "min": 1, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "id": "List.identifier.value", "path": "List.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.", "comment": "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](extension-rendered-value.html).", "min": 1, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "123456" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ] }, { "id": "List.identifier.period", "path": "List.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.empty() or end.empty() or (start <= end)", "xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "List.identifier.assigner", "path": "List.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ] }, { "id": "List.status", "path": "List.status", "short": "current | retired | entered-in-error", "definition": "Indicates the current state of this list.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "base": { "path": "List.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "fixedCode": "current", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListStatus" } ], "strength": "required", "description": "The current state of the list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-status" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".status[current=active;retired=obsolete;entered-in-error=nullified]" }, { "identity": "w5", "map": "status" } ] }, { "id": "List.mode", "path": "List.mode", "short": "working | snapshot | changes", "definition": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "comment": "This element is labeled as a modifier because a change list must not be mis-understood as a complete list.", "requirements": "Lists are used in various ways, and it must be known in what way it is safe to use them.", "min": 1, "max": "1", "base": { "path": "List.mode", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "fixedCode": "snapshot", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListMode" } ], "strength": "required", "description": "The processing mode that applies to this list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-mode" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "w5", "map": "class" } ] }, { "id": "List.title", "path": "List.title", "short": "Descriptive name for the list", "definition": "A label for the list assigned by the author.", "comment": "Note that FHIR strings may not exceed 1MB in size", "requirements": "Allows customization beyond just the code identifying the kind of list.", "min": 0, "max": "1", "base": { "path": "List.title", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Dr. Jane's Patients" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".title" } ] }, { "id": "List.code", "path": "List.code", "short": "What the purpose of this list is", "definition": "This code defines the purpose of the list - why it was created.", "comment": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.", "requirements": "Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.", "min": 1, "max": "1", "base": { "path": "List.code", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListPurpose" } ], "strength": "extensible", "description": "What the purpose of a list is", "valueSetReference": { "reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ListCode-1" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] }, { "id": "List.subject", "path": "List.subject", "short": "If all resources have the same subject", "definition": "The common subject (or patient) of the resources that are in the list, if there is one.", "comment": "Some purely arbitrary lists do not have a common subject, so this is optional.", "requirements": "The primary purpose of listing the subject explicitly is to help with finding the right list.", "min": 1, "max": "1", "base": { "path": "List.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".participation[typeCode<SUB].role (and sometimes .player)" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "List.encounter", "path": "List.encounter", "short": "Context in which list created", "definition": "The encounter that is the context in which this list was created.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "List.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "id": "List.date", "path": "List.date", "short": "When the list was prepared", "definition": "The date that the list was prepared.", "comment": "The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.", "requirements": "Identifies how current the list is which affects relevance.", "min": 0, "max": "1", "base": { "path": "List.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".participation[typeCode<AUT].time[type=TS]" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "List.source", "path": "List.source", "short": "Who and/or what defined the list contents (aka Author)", "definition": "The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.", "comment": "The primary source is the entity that made the decisions what items are in the list. This may be software or user.", "requirements": "Allows follow-up as well as context.", "alias": [ "Author" ], "min": 0, "max": "1", "base": { "path": "List.source", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "List.orderedBy", "path": "List.orderedBy", "short": "What order the list has", "definition": "What order applies to the items in the list.", "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "min": 0, "max": "1", "base": { "path": "List.orderedBy", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListOrder" } ], "strength": "preferred", "description": "What order applies to the items in a list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-order" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" } ] }, { "id": "List.note", "path": "List.note", "short": "Comments about the list", "definition": "Comments that apply to the overall list.", "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).", "min": 0, "max": "*", "base": { "path": "List.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].act.text" } ] }, { "id": "List.note.id", "path": "List.note.id", "representation": [ "xmlAttr" ], "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.note.extension", "path": "List.note.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.note.author[x]", "path": "List.note.author[x]", "short": "Individual responsible for the annotation", "definition": "The individual responsible for making the annotation.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Annotation.author[x]", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "string" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.participant[typeCode=AUT].role" } ] }, { "id": "List.note.time", "path": "List.note.time", "short": "When the annotation was made", "definition": "Indicates when this particular annotation was made.", "min": 0, "max": "1", "base": { "path": "Annotation.time", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.effectiveTime" } ] }, { "id": "List.note.text", "path": "List.note.text", "short": "The annotation - text content", "definition": "The text of the annotation.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "Annotation.text", "min": 1, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act.text" } ] }, { "id": "List.entry", "path": "List.entry", "short": "Entries in the list", "definition": "Entries in this list.", "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "min": 0, "max": "*", "base": { "path": "List.entry", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1", "lst-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" } ] }, { "id": "List.entry.id", "path": "List.entry.id", "representation": [ "xmlAttr" ], "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.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "List.entry.extension", "path": "List.entry.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.entry.modifierExtension", "path": "List.entry.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "comment": "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "List.entry.flag", "path": "List.entry.flag", "short": "Status/Workflow information about this item", "definition": "The flag allows the system constructing the list to indicate the role and significance of the item in the list.", "comment": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".", "requirements": "This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.", "min": 0, "max": "1", "base": { "path": "List.entry.flag", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListItemFlag" } ], "strength": "example", "description": "Codes that provide further information about the reason and meaning of the item in the list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/list-item-flag" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" } ] }, { "id": "List.entry.deleted", "path": "List.entry.deleted", "short": "If this item is actually marked as deleted", "definition": "True if this item is marked as deleted in the list.", "comment": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.\n\nThis element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.", "requirements": "The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as \"deleted\".", "min": 0, "max": "1", "base": { "path": "List.entry.deleted", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "ele-1", "lst-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "added: .updateMode=(\"A\",\"AR\") retained: .updateMode=\"NC\" updated: .updateMode=\"R\" deleted: .updateMode=\"D\"" } ] }, { "id": "List.entry.date", "path": "List.entry.date", "short": "When item added to list", "definition": "When this item was added to the list.", "comment": "This is only useful and meaningful when the mode is \"working\".", "requirements": "The date may be significant for understanding the meaning of items in a working list.", "min": 0, "max": "1", "base": { "path": "List.entry.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".availabilityTime" } ] }, { "id": "List.entry.item", "path": "List.entry.item", "short": "Actual entry", "definition": "A reference to the actual resource from which data was derived.", "comment": "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.", "min": 1, "max": "1", "base": { "path": "List.entry.item", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".target or .role or .role.entity" } ] }, { "id": "List.emptyReason", "path": "List.emptyReason", "short": "Why list is empty", "definition": "If the list is empty, why the list is empty.", "comment": "The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "min": 0, "max": "1", "base": { "path": "List.emptyReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1", "lst-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListEmptyReason" } ], "strength": "required", "description": "If a list is empty, why it is empty", "valueSetReference": { "reference": "https://fhir.nhs.uk/STU3/ValueSet/CareConnect-ListEmptyReasonCode-1" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]" } ] } ] }, "differential": { "element": [ { "id": "List.meta.profile", "path": "List.meta.profile", "min": 1 }, { "id": "List.extension", "path": "List.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "List.extension:clinicalSetting", "path": "List.extension", "sliceName": "clinicalSetting", "type": [ { "code": "Extension", "profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" } ], "mustSupport": true }, { "id": "List.extension:warningCode", "path": "List.extension", "sliceName": "warningCode", "type": [ { "code": "Extension", "profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ListWarningCode-1" } ], "mustSupport": true }, { "id": "List.extension:relatedProblemHeader", "path": "List.extension", "sliceName": "relatedProblemHeader", "short": "A reference to any related problems", "definition": "A reference to any related problems.", "type": [ { "code": "Extension", "profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" } ], "mustSupport": true }, { "id": "List.extension:relatedProblemHeader.url", "path": "List.extension.url", "fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1" }, { "id": "List.identifier.system", "path": "List.identifier.system", "min": 1 }, { "id": "List.identifier.value", "path": "List.identifier.value", "min": 1 }, { "id": "List.identifier.assigner", "path": "List.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" } ] }, { "id": "List.status", "path": "List.status", "fixedCode": "current" }, { "id": "List.mode", "path": "List.mode", "fixedCode": "snapshot" }, { "id": "List.code", "path": "List.code", "min": 1, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListPurpose" } ], "strength": "extensible", "valueSetReference": { "reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ListCode-1" } } }, { "id": "List.subject", "path": "List.subject", "min": 1, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1" } ] }, { "id": "List.encounter", "path": "List.encounter", "type": [ { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1" } ] }, { "id": "List.source", "path": "List.source", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" } ] }, { "id": "List.note", "path": "List.note", "mustSupport": true }, { "id": "List.note.author[x]", "path": "List.note.author[x]", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "string" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" }, { "code": "Reference", "targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" } ] }, { "id": "List.entry", "path": "List.entry", "mustSupport": true }, { "id": "List.emptyReason", "path": "List.emptyReason", "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ListEmptyReason" } ], "strength": "required", "valueSetReference": { "reference": "https://fhir.nhs.uk/STU3/ValueSet/CareConnect-ListEmptyReasonCode-1" } } } ] } }
Background
The List
profile is used to manage collections of resources.
In GP Connect, it is used to organise data returned by a query into groups of resources that can then be processed more easily. For each clinical area query, GP Connect will return a list that identifies the data returned for that query.
- when an API call returns data for more than one clinical area, the list will identify which data has been returned for which clinical area
- where there are no items returned, the list will be empty
- where the return includes warning messages (for example, when clinical data is excluded), those messages will be in the list profile.manage negation where no resources are present in a system to be returned by a query - an attribution that is common to the resources it references will be returned, differentiating between items at different stages of a workflow, providing a mechanism to deal with warnings that can be applied to the group of resources
Using the List resource for consultation queries
The results of a query for consultation details MUST return a List
containing references to all the Encounter
resources which represent each consultation that is returned.
The List
MUST be populated in line with the guidance on List
resources.
If the List
is empty, then an empty List
MUST be returned with an emptyReason.code
with the value no-content-recorded
. In this case, List.note
MUST be populated with the text ‘Information not available’.
A two or three level List
structure is used to represent structured consultations.
- List (Consultation)
- List (Topic)
- List (Heading)
List (Consultation)
This top-level profile represents the structured consultation as a whole, and SHALL be coded as 325851000000107 | Consultation encounter type (record artifact) |.
List (Topic)
This level represents the Topic / Problem groupings within consultations, and SHALL be coded as 25851000000105 | Topic (EHR) (record artifact) |
List (Heading)
This level represents the headings (SOAP heading) levels of the consultation structure that contain record entries, and SHALL be coded as 24781000000107 | Category (EHR) (record artifact) |.
In the case of consultation which has a 'flat' structure, that is, it contains record entries without a surrounding Topic / Heading structure, producer systems generate a List(Topic) level which links directly to record entries without the List(Heading) level.
Empty consultations and empty subsections (topics and headings) are suppressed at source and this is reflected in the cardinalities specified.
Data model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
id | |||
meta.versionId | |||
meta.lastUpdated | |||
meta.profile | |||
meta.security | |||
meta.tag | |||
extension(clinicalSetting) | |||
extension(warningCode) | |||
extension(relatedProblemHeader) | |||
identifier | |||
status | |||
mode | |||
title | |||
code | |||
subject | |||
encounter | |||
date | |||
source | |||
source | |||
entry | |||
emptyReason |
id
Usage
Optional
Guidance
The id
is the logical identifier for the CareConnect-GPC-List-1
profile.
Example
<id value="9c338a99-0e2a-43cf-8cd0-1d2661fc94ae" />
meta.versionId
Usage
Optional
Guidance
The population of the meta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.
Example
<meta> <versionId value="1" /> </meta>
meta.lastUpdated
Usage
Optional
Guidance
The meta.lastUpdated
element could be useful alongside the meta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.
Example
<meta> <lastUpdated value="2022-10-28T08:06:00+00:00" /> </meta>
meta.profile
Usage
Mandatory
Guidance
The meta.profile
contains a fixed value of the URL for the CareConnect-GPC-List-1
profile.
Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-List-1" /> </meta>
meta.security
Usage
Optional
Guidance
A use-case for the meta.security
element within GP Connect has not yet been defined.
Example
<meta> <security> <coding> <system value="http://hl7.org/fhir/v3/Confidentiality" /> <code value="L" /> <display value="low" /> </coding> </security> </meta>
meta.tag
Usage
Optional
Guidance
A use-case for the meta.tag
element within GP Connect has not been defined.
Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
extension(clinicalSetting)
Usage
Required
Guidance
careSettingType
in FHIR UK Core.
For structural list use only
This element should be populated with the care setting that the activity relates to, providing it is known by the provider system. It is recommended to use a value from the UKCore-List.extension:careSettingType
value-set when populating this element.
For GP Connect this should be set to ‘1060971000000108 General practice service’.
Value-set: UK Core Care Setting Type
Example
<extension> <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-ClinicalSetting-1" /> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="1060971000000108" /> <display value="General practice service" /> </coding> </valueCodeableConcept> </extension>
extension(warningCode)
Usage
Required
Guidance
For structural list use only
A code or codes warning of an issue related to this list.
This extension is used to capture warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit. It MUST be populated using the appropriate code from the table in the warning codes section on the resource population fundamentals page.
Example
<extension> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ListWarningCode-1" /> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ListWarningCode-1" /> <code value="data-awaiting-filing" /> <display value="Data Awaiting Filing" /> </coding> </valueCodeableConcept> </extension>
identifier
Usage
Optional
Guidance
The identifier
element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.
Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.
Example
<identifier> <system value="https://foo.bar/id/list" /> <value value="3d68a68bf-dc19-4e43-af95-cc84ba151583" /> </identifier>
status
Usage
Mandatory
Guidance
Whether the list is current
, retired
or entered-in-error
.
current
MUST be used for all lists in GP Connect.
Example
<status value="current" />
mode
Usage
Mandatory
Guidance
Whether the List has a mode
of working
, snapshot
, or changes
.
snapshot
MUST be used for all lists in GP Connect.
Example
<mode value="snapshot" />
title
Usage
Optional
Guidance
A human-readable title of the list being sent.
For structural lists
Descriptive name for the list. The list titles for primary and secondary lists MUST be the titles as provided in the tables in
For lists used in consultations
For example:
List(Consultation)
- use the type or the name of the consultation, as it appears to users of the users in the source system
- this will be a duplicate of consultation type / name provided in
Encounter.type
List(Topic)
- the name of the corresponding Topic section in the source consultation (if it is named)
List(Heading)
- the name of the heading section on the source system
Example
<title value="Face to face consultation encounter type (record artifact)" />
code
Usage
Mandatory
Guidance
A codeable concept to represent the type of list being sent.
For structural lists
The purpose of the list.
There are currently 9 possible purposes of a list in response to a query for a clinical area in GP Connect that will be represented by the following SNOMED codes.
Purpose | SNOMED Code | SNOMED Preferred Term / List.title |
---|---|---|
Medications and medical devices | 933361000000108 | Medications and medical devices |
Allergies and adverse reactions | 886921000000105 | Allergies and adverse reaction |
Ended allergies | 1103671000000101 | Ended allergies |
Immunisations | 1102181000000102 | Immunisations |
List of consultations | 1149501000000101 | List of consultations |
Problems | 717711000000103 | Problems |
Uncategorised data | 826501000000100 | Miscellaneous record |
Outbound Referrals | 792931000000107 | Outbound referral |
Investigations | 887191000000108 | Investigations and Results |
Diary Entries | 714311000000108 | Patient recall administration |
The above code for ‘Ended allergies’ should be used for resolved allergies.
For lists used in consultations
List(Consultation)
- provide the SNOMED: 325851000000107 | Consultation encounter type (record artifact) |
List(Topic)
- provide the SNOMED: 25851000000105 | Topic (EHR) (record artifact) |
List(Heading)
- provide the SNOMED: 24781000000107 | Category (EHR) (record artifact) |
Example
<code> <coding> <system value="http://snomed.info/sct" /> <code value="25851000000105" /> <display value="Topic (EHR) (record artifact)" /> </coding> </code>
subject
Usage
Mandatory
Guidance
For structural lists
Reference to the Patient
profile.
For lists used in consultations
Reference to the Patient
profile for the patient whose patient record contains a consultation represented by this List profile.
The patient reference is provided by all Lists in the structure rather than the top-level List(Consultation) only.
Example
<subject> <reference value="patient-009oap2" /> </subject>
encounter
Usage
Optional
Guidance
For lists used in consultations
Mandatory reference to the Encounter
profile providing the context for the consultation (Date/Doctor/Place ….)
The Encounter reference is provided by all Lists in the structure rather than the top-level List(Consultation) only.
Example
<encounter> <reference value="encounter-12iaq" /> </encounter>
date
Usage
Optional
Guidance
For structural lists
Where the list is used to create primary or secondary lists in response to a query this is when the list was created.
For lists used in consultations
The system rather than clinical date time for when the consultation was last edited, that is, the date time the consultation was last modified on the source system.
If no separate date time is recorded for consultation sub sections, the overall audit date of the consultation is replicated at all levels.
The clinically significant or effective consultation date is provided by the associated Encounter
profile.
Example
<date value="2022-11-01T11:09:00Z">
source
Usage
Optional
Guidance
The person or clinical system responsible for decided what the contents of the list were. Where the list was created by a human, then this is the same as the list author.
Example
<source> <reference value="device-or-practitioner-or-patient--008fjdk2" /> </source>
orderedBy
Usage
Optional
Guidance
For structural lists
What order the list is in.
Example
<orderedBy> <coding> <system value="http://terminology.hl7.org/CodeSystem/list-order" /> <code value="system" /> <display value="Sorted by System" /> </coding> </orderedBy>
For lists used in consultations
The order the list has been provided. By convention the list entries should appear in the same order as they appear in the source system.
As such, in most cases it is expected that this element will be populated with the value system
.
Example
<orderedBy> <coding> <system value="http://terminology.hl7.org/CodeSystem/list-order" /> <code value="system" /> <display value="Sorted by System" /> </coding> </orderedBy>
note
Usage
Optional
Guidance
For structural list use only
The note
element can be used to provide any comments regarding the list.
The text versions of any warning messages included with the list. Where there are multiple warning messages their text is concatenated.
Example
<note> <author> <reference value="practitioner-0019asb" /> </author> <time value="2022-11-01T11:29:00Z" /> <text> Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM). </text> </note>
entry
Usage
Required
Guidance
Individual entries within the List
resource.
The entry.item
will contain a reference to a profile which represents a clinical record entry in the source system.
For example:
- medication
- allergy
- problem
- diagnosis
- and so on
They will be recorded in the same order that the items appear when viewed in a consultation in the GP system.
Example
<entry> <!-- Patient Medicine Change Types --> <flag> <coding> <system value="urn:oid:1.2.36.1.2001.1001.101.104.16592" /> <code value="04" /> <display value="Prescribed" /> </coding> </flag> <deleted value="false" /> <date value="2022-11-01T11:09:00Z" /> <item> <reference value="medication-001123" /> </item> </entry>
emptyReason
Usage
Required
Guidance
For structural list use only
Explanation as to why the list is empty (if applicable).
A FHIR code of no-content-recorded
MUST be recorded in emptyReason.code
if a query returns no results to enter into a list. In this case, List.note
MUST be populated with the text ‘Information not available’.
Example
<emptyReason> <coding> <system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-ListEmptyReasonCode-1" /> <code value="no-content-recorded" /> <display value="No Content Recorded" /> </coding> </emptyReason>