List profile

Management

Profile/ListPTCore.StructureDefinition.json

Tree view

ListPTCore (List)	I		List	There are no (further) constraints on this element Element id List Short description A list is a curated collection of resources Alternate names Collection, WorkingList, Organizer Definition A list is a curated collection of resources. Data type List Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` lst-3: An entry date can only be used if the mode of the list is "working" `mode = 'working' or entry.date.empty()` lst-2: The deleted flag can only be used if the mode of the list is "changes" `mode = 'changes' or entry.deleted.empty()` lst-1: A list can only have an emptyReason if it is empty `emptyReason.empty() or entry.empty()` Mappings rim: Entity. Role, or Act rim: Act[classCode<ORG,moodCode=EVN] w5: infrastructure.documents
id	Σ	1..1	id	There are no (further) constraints on this element Element id List.id Short description 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. 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. Data type id
meta	Σ	0..1	MetaPTCore	Element id List.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type MetaPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id List.implicitRules Short description 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id List.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding IETF language tag CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id List.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can 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. 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 information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: N/A rim: Act.text?
contained	I	0..*	Resource	There are no (further) constraints on this element Element id List.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Constraints dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id List.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
identifier		0..*	ExtensionIdentifierPTCore	Element id List.identifier Short description An identifier intended for computation Definition Identificador local da lista por parte do negócio. Data type ExtensionIdentifierPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier rim: .id
id		0..1	id	There are no (further) constraints on this element Element id List.identifier.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id List.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition Propósito do identificador: official: O identificador considerado mais fiável para a identificação do item. temp: Um identificador temporário. secondary: Um identificador que foi atribuído para identificar o item em um contexto relativo, mas não pode usado em um contexto diferente. old: O identificador já não é considerado válido, mas pode ser relevante para fins de pesquisa. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptPTCoreBinding	There are no (further) constraints on this element Element id List.identifier.type Short description Concept - reference to a terminology or just text Definition A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments Value Set: ExtensionIdentifierType Data type CodeableConceptPTCore Binding ExtensionIdentifierType (extensible) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
id		0..1	id	There are no (further) constraints on this element Element id List.identifier.type.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.identifier.type.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
coding	Σ	0..*	CodingPTCore	There are no (further) constraints on this element Element id List.identifier.type.coding Short description A reference to a code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type CodingPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	id	Element id List.identifier.type.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Comments . Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.identifier.type.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
system	Σ	1..1	uri	There are no (further) constraints on this element Element id List.identifier.type.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..0	string	There are no (further) constraints on this element Element id List.identifier.type.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	There are no (further) constraints on this element Element id List.identifier.type.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	There are no (further) constraints on this element Element id List.identifier.type.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..0	boolean	There are no (further) constraints on this element Element id List.identifier.type.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	1..1	string	There are no (further) constraints on this element Element id List.identifier.type.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
system	Σ	0..1	uri	There are no (further) constraints on this element Element id List.identifier.system Short description 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. 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 Para sistemas geridos pela SPMS o system tem de seguir a seguinte estrutura: http://spms.min-saude.pt/<sistema>/identifiers/<identifier-id> Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General http://www.acme.com/identifiers/patient Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id List.identifier.value Short description 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. 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General 123456 Mappings rim: n/a v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ I	0..1	PeriodPTCore	There are no (further) constraints on this element Element id List.identifier.period Short description Time range defined by start and end date/time Alternate names Period Definition A time period defined by a start and end date and optionally time. Comments 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"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type PeriodPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ I	0..0	Reference(OrganizationPTCore)	There are no (further) constraints on this element Element id List.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. 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. Data type Reference(OrganizationPTCore) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
status	Σ ?!	1..1	codeBinding	Element id List.status Short description current \| retired \| entered-in-error Definition Identifica o estado da lista: “current” - A lista é considerada uma parte ativa do registro “retired” - A lista é "antiga" e não deve mais ser considerada “entered-in-error” - Inserida por erro, a lista não deve ser considerada Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data type code Binding The current state of the list. ListStatus (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a w5: FiveWs.status rim: .status[current=active;retired=obsolete;entered-in-error=nullified]
mode	Σ ?!	1..1	codeBinding	Element id List.mode Short description working \| snapshot \| changes Definition Identifica o modo de criação da lista, modified or deleted: “working” - lista mestra, mantida de forma contínua com atualizações regulares “snapshot” - lista de um determimado momento “changes” - Uma lista que mostra quais alterações foram feitas ou recomendadas 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 misunderstood as a complete list. Data type code Binding The processing mode that applies to this list. ListMode (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a w5: FiveWs.class rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
title	Σ	0..1	string	Element id List.title Short description Descriptive name for the list Definition Nome da lista. Requirements Allows customization beyond just the code identifying the kind of list. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General Dr. Jane's Patients Mappings rim: n/a rim: .title
code	Σ	0..1	CodeableConceptPTCoreBinding	Element id List.code Short description Concept - reference to a terminology or just text Definition Objetivo da Lista Requirements Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. Comments Value Set Name: Type of List Data type CodeableConceptPTCore Binding What the purpose of a list is. https://www.ctc.min-saude.pt/catalogos/apoio-ao-registo-clinico (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.what[x] rim: .code
subject	Σ I	0..1	Reference(PatientPTCore \| https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/GroupPTCore \| https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/DevicePTCore \| LocationPTCore)	Element id List.subject Short description If all resources have the same subject Definition Assunto da Lista. Algumas listas puramente arbitrárias e não têm um assunto comum, sendo assim opcional a identificação deste elemento. 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. Data type Reference(PatientPTCore \| https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/GroupPTCore \| https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/DevicePTCore \| LocationPTCore) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.subject[x] rim: .participation[typeCode<SUB].role (and sometimes .player) w5: FiveWs.subject
encounter	I	0..1	Reference(https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/EncounterPTCore)	Element id List.encounter Short description Context in which list created Definition O episódio em que a lista é criada. 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. Data type Reference(https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/EncounterPTCore) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.context rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
date	Σ	0..1	dateTime	Element id List.date Short description When the list was prepared Definition Data e hora em que a lista é preparada. Uma data ou data parcial ou data e hora, sendo o formato definido pela ISO8601. Se a hora e minutos forem especificados, descrição da time zone (UTC) DEVE ser preenchida. Os segundos devem ser fornecidos devido a restrições de tipo de esquema, mas podem ser preenchidos com zero. O horário "24:00" não é permitido. Formatos possíveis: ano; ano e mês; ano, mês e dia; YYYY-MM-DDThh:mm:ss+zz:zz - ano, mês, dia , hora, minutos , segundos e time zone. 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. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a w5: FiveWs.recorded rim: .participation[typeCode<AUT].time[type=TS]
source	Σ I	0..1	Reference(PractitionerPTCore \| PractitionerRolePTCore \| PatientPTCore \| https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/DevicePTCore)	Element id List.source Short description Who and/or what defined the list contents (aka Author) Alternate names Author Definition A entidade responsável por decidir qual era o conteúdo da lista ou o autor da lista. 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. Data type Reference(PractitionerPTCore \| PractitionerRolePTCore \| PatientPTCore \| https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/DevicePTCore) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.author rim: .participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]
orderedBy		0..1	CodeableConceptPTCoreBinding	Element id List.orderedBy Short description Concept - reference to a terminology or just text Definition A ordem aplicada aos itens da lista. Utilizar o Value Set “ListOrderCodes” do FHIR Requirements Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConceptPTCore Binding What order applies to the items in a list. ListOrderCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
note		0..*	AnnotationPTCore	Element id List.note Short description Text node with attribution Definition Observações 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). Data type AnnotationPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: N/A rim: Act rim: .inboundRelationship[typeCode=SUBJ].act.text
entry	I	0..*	BackboneElement	There are no (further) constraints on this element Element id List.entry Short description Entries in the list Definition Entries in this list. Comments If there are no entries in the list, an emptyReason SHOULD be provided. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
id		0..1	id	There are no (further) constraints on this element Element id List.entry.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id List.entry.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id List.entry.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
flag		0..1	CodeableConcept	Element id List.entry.flag Short description Status/Workflow information about this item Definition O elemento flag deve ser preenchido tendo em contexto do valor colocado no elemento List.code. 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". Data type CodeableConcept Binding Codes that provide further information about the reason and meaning of the item in the list. PatientMedicineChangeTypes (example) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
deleted	?! I	0..1	boolean	Element id List.entry.deleted Short description If this item is actually marked as deleted Definition Indicação se a entrada foi excluída da lista true \| false 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. Meaning when missing List items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes' Data type boolean Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"
date		0..1	dateTime	Element id List.entry.date Short description When item added to list Definition Data e hora da lista. Uma data ou data parcial ou data e hora, sendo o formato definido pela ISO8601. Se a hora e minutos forem especificados, descrição da time zone (UTC) DEVE ser preenchida. Os segundos devem ser fornecidos devido a restrições de tipo de esquema, mas podem ser preenchidos com zero. O horário "24:00" não é permitido. Formatos possíveis: ano; ano e mês; ano, mês e dia; YYYY-MM-DDThh:mm:ss+zz:zz - ano, mês, dia , hora, minutos , segundos e time zone. Requirements The date may be significant for understanding the meaning of items in a working list. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: .availabilityTime
item	I	1..1	Reference(Resource)	Element id List.entry.item Short description Actual entry Definition Referência ao recurso elemento da lista 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. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: .target or .role or .role.entity
emptyReason	I	0..1	CodeableConceptPTCoreBinding	Element id List.emptyReason Short description Concept - reference to a terminology or just text Definition Motivo da lista estar vazia. Esta informação encontra-se disponível no catálogo CPARADM Value Set “List Empty Reason“. O catálogo pode ser solicitado ao https://www.ctc.min-saude.pt/ . Requirements Allows capturing things like "none exist" or "not asked" which can be important for most lists. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConceptPTCore Binding If a list is empty, why it is empty. https://www.ctc.min-saude.pt/catalogos/apoio-ao-registo-administrativo (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]

Binding

Path	Strength	ValueSet	Comment
List.code	required	https://www.ctc.min-saude.pt/catalogos/apoio-ao-registo-clinico	Value Set Name: Type of List
List.emptyReason	required	https://www.ctc.min-saude.pt/catalogos/apoio-ao-registo-administrativo

Path

Strength

ValueSet

Comment

List.code

required

https://www.ctc.min-saude.pt/catalogos/apoio-ao-registo-clinico

Value Set Name: Type of List

List.emptyReason

required

https://www.ctc.min-saude.pt/catalogos/apoio-ao-registo-administrativo

Binding do FHIR Required

Path	strength	ValueSet
List.status	required	ListStatus
List.mode	required	ListMode

Identifiers Type

Estes Identificadores devem ser utilizados no elemento

identifier.type.coding[*]

Regras de implementação

Para além das constraints identificadas pelo FHIR para este recurso devem ser consideradas as constraints que identificamos na tabela infra.

Voltar ao início