Profile: CareConnect-GPC-List-1
CareConnect-GPC-List-1 (List) | C | List | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | 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 | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
clinicalSetting | S C | 0..1 | Extension(CodeableConcept) |
warningCode | S C | 0..* | Extension(code) |
relatedProblemHeader | S C | 0..* | Extension(Complex) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
type | C | 0..* | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueCode | 0..1 | codeBinding | |
target | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueReference | 0..1 | Reference(CareConnect-ProblemHeader-Condition-1) | |
url | 1..1 | uriAuto Value | |
value[x] | 0..0 | ||
modifierExtension | ?! | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(CareConnect-GPC-Organization-1) |
status | Σ ?! | 1..1 | codeBindingAuto Value |
mode | Σ ?! | 1..1 | codeBindingAuto Value |
title | Σ | 0..1 | string |
code | Σ | 1..1 | CodeableConceptBinding |
subject | Σ | 1..1 | Reference(Group | Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Location-1) |
encounter | 0..1 | Reference(CareConnect-GPC-Encounter-1) | |
date | Σ | 0..1 | dateTime |
source | Σ | 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 | 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 C | 0..* | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
flag | 0..1 | CodeableConcept | |
deleted | ?! C | 0..1 | boolean |
date | 0..1 | dateTime | |
item | 1..1 | Reference(Resource) | |
emptyReason | S C | 0..1 | CodeableConceptBinding |
List | |||
Short | Information summarized from a list of other resources | ||
Definition | A set of information summarized from a list of other resources. | ||
Cardinality | 0..* | ||
Alias | Collection, WorkingList, Organizer | ||
Constraints |
| ||
Mappings |
| ||
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. | ||
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. | ||
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. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
List.meta.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
List.meta.extension | |||
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. | ||
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) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
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. | ||
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. | ||
List.meta.lastUpdated | |||
Short | When the resource version last changed | ||
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. | ||
List.meta.profile | |||
Short | Profiles this resource claims to conform to | ||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
Cardinality | 1..* | ||
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. | ||
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. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
Summary | True | ||
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
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. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||
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. | ||
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. | ||
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. | ||
List.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
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). | ||
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. | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
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. | ||
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 | |||
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. | ||
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) | ||
Mappings |
| ||
List.extension:clinicalSetting | |||
Short | To record the clinical setting of a problem list | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:warningCode | |||
Short | To capture warnings that the list may be incomplete | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader | |||
Short | A reference to any related problems | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension | |||
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. | ||
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) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:type | |||
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. | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:type.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:type.extension | |||
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. | ||
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) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:type.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | type | ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:type.value[x]:valueCode | |||
Short | Condition relationship type | ||
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. | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:target | |||
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. | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:target.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:target.extension | |||
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. | ||
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) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:target.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | target | ||
Mappings |
| ||
List.extension:relatedProblemHeader.extension:target.value[x]:valueReference | |||
Short | Target problem header condition | ||
Definition | Target problem header condition. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-ProblemHeader-Condition-1) | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.extension:relatedProblemHeader.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedProblemHeader-1 | ||
Mappings |
| ||
List.extension:relatedProblemHeader.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
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 | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
List.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 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. | ||
Mappings |
| ||
List.identifier | |||
Short | Business identifier | ||
Definition | Identifier for the List assigned for business purposes outside the context of FHIR. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Mappings |
| ||
List.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
List.identifier.extension | |||
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. | ||
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) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
List.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
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. | ||
Mappings |
| ||
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. | ||
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. | ||
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. | ||
Mappings |
| ||
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. | ||
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. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
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. | ||
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. | ||
Examples | General123456 | ||
Mappings |
| ||
List.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
List.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Summary | True | ||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
Mappings |
| ||
List.status | |||
Short | current | retired | entered-in-error | ||
Definition | Indicates the current state of this list. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The current state of the list | ||
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. | ||
Auto Value | current | ||
Mappings |
| ||
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. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The processing mode that applies to this list | ||
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. | ||
Auto Value | snapshot | ||
Mappings |
| ||
List.title | |||
Short | Descriptive name for the list | ||
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. | ||
Examples | GeneralDr. Jane's Patients | ||
Mappings |
| ||
List.code | |||
Short | What the purpose of this list is | ||
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 | ||
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. | ||
Mappings |
| ||
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. | ||
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. | ||
Mappings |
| ||
List.encounter | |||
Short | Context in which list created | ||
Definition | The encounter that is the context in which this list was created. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Encounter-1) | ||
Mappings |
| ||
List.date | |||
Short | When the list was prepared | ||
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. | ||
Mappings |
| ||
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. | ||
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. | ||
Mappings |
| ||
List.orderedBy | |||
Short | What order the list has | ||
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 | ||
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. | ||
Mappings |
| ||
List.note | |||
Short | Comments about the list | ||
Definition | Comments that apply to the overall list. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Must Support | True | ||
Mappings |
| ||
List.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
List.note.extension | |||
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. | ||
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) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
List.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(RelatedPerson | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1), string | ||
Summary | True | ||
Mappings |
| ||
List.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
List.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
List.entry | |||
Short | Entries in the list | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: lst-1 | ||
Constraints |
| ||
Mappings |
| ||
List.entry.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
List.entry.extension | |||
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. | ||
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. | ||
Mappings |
| ||
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. | ||
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. | ||
Mappings |
| ||
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. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Codes that provide further information about the reason and meaning of the item in the list | ||
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". | ||
Mappings |
| ||
List.entry.deleted | |||
Short | If this item is actually marked as 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: lst-2 | ||
Default value | false | ||
Mappings |
| ||
List.entry.date | |||
Short | When item added to list | ||
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". | ||
Mappings |
| ||
List.entry.item | |||
Short | Actual entry | ||
Definition | A reference to the actual resource from which data was derived. | ||
Cardinality | 1..1 | ||
Type | Reference(Resource) | ||
Mappings |
| ||
List.emptyReason | |||
Short | Why list is empty | ||
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 | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: lst-1 | ||
Mappings |
|