- Home
- Profiles
- Management
- ListPTPS profile
ProfilePTPS/ListPTPS.StructureDefinition.json
ListPTPS (List) | I | ListPTCore | There are no (further) constraints on this element Element idList A list is a curated collection of resources Alternate namesCollection, WorkingList, Organizer DefinitionA list is a curated collection of resources.
| |
id | Σ | 1..1 | id | There are no (further) constraints on this element Element idList.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | MetaPTCore | There are no (further) constraints on this element Element idList.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idList.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idList.language Language of the resource content DefinitionThe base language in which the resource is written. 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). IETF language tag
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idList.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | I | 0..* | Resource | There are no (further) constraints on this element Element idList.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idList.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | ExtensionIdentifierPTCore | Element idList.identifier An identifier intended for computation DefinitionIdentificador local da lista por parte do negócio. Em contento do Patient Summary é usado para identificar o unique-id da secção.
| |
id | 0..1 | id | There are no (further) constraints on this element Element idList.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idList.identifier.use usual | official | temp | secondary | old (If known) DefinitionPropó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. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
type | Σ | 0..0 | CodeableConceptPTCoreBinding | There are no (further) constraints on this element Element idList.identifier.type Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Allows users to make use of identifiers when the identifier system is not known. Value Set: ExtensionIdentifierType ExtensionIdentifierType (extensible) Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idList.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Para sistemas geridos pela SPMS o system tem de seguir a seguinte estrutura: http://spms.min-saude.pt/<sistema>/identifiers/<identifier-id>
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idList.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..0 | PeriodPTCore | There are no (further) constraints on this element Element idList.identifier.period Time range defined by start and end date/time Alternate namesPeriod DefinitionA time period defined by a start and end date and optionally time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..0 | Reference(OrganizationPTCore) | There are no (further) constraints on this element Element idList.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idList.status current | retired | entered-in-error DefinitionIdentifica 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 This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The current state of the list.
|
mode | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idList.mode working | snapshot | changes DefinitionIdentifica 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 Lists are used in various ways, and it must be known in what way it is safe to use them. This element is labeled as a modifier because a change list must not be misunderstood as a complete list. The processing mode that applies to this list.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.title Descriptive name for the list DefinitionNome da lista. Allows customization beyond just the code identifying the kind of list. Note that FHIR strings SHALL NOT exceed 1MB in size
General Dr. Jane's Patients Mappings
|
code | Σ | 0..1 | CodeableConceptPTCoreBinding | There are no (further) constraints on this element Element idList.code Concept - reference to a terminology or just text DefinitionObjetivo da Lista Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. Value Set Name: Type of List What the purpose of a list is.
|
subject | Σ I | 0..1 | Reference(PatientPTPS) | Element idList.subject If all resources have the same subject DefinitionAssunto da Lista. Algumas listas puramente arbitrárias e não têm um assunto comum, sendo assim opcional a identificação deste elemento. The primary purpose of listing the subject explicitly is to help with finding the right list. Some purely arbitrary lists do not have a common subject, so this is optional.
|
encounter | I | 0..0 | Reference(https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/EncounterPTCore) | There are no (further) constraints on this element Element idList.encounter Context in which list created DefinitionO episódio em que a lista é criada. 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. Reference(https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/EncounterPTCore) Constraints
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idList.date When the list was prepared DefinitionData 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:
Identifies how current the list is which affects relevance. 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.
|
source | Σ I | 0..0 | Reference(PractitionerPTCore | PractitionerRolePTCore | PatientPTCore | https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/DevicePTCore) | There are no (further) constraints on this element Element idList.source Who and/or what defined the list contents (aka Author) Alternate namesAuthor DefinitionA entidade responsável por decidir qual era o conteúdo da lista ou o autor da lista. Allows follow-up as well as context. The primary source is the entity that made the decisions what items are in the list. This may be software or user. Reference(PractitionerPTCore | PractitionerRolePTCore | PatientPTCore | https://spms.min-saude.pt/fhir-r4B/iop/StructureDefinition/DevicePTCore) Constraints
|
orderedBy | 0..0 | CodeableConceptPTCoreBinding | There are no (further) constraints on this element Element idList.orderedBy Concept - reference to a terminology or just text DefinitionA ordem aplicada aos itens da lista. Utilizar o Value Set “ListOrderCodes” do FHIR Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. 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. What order applies to the items in a list.
| |
note | 0..0 | AnnotationPTCore | There are no (further) constraints on this element Element idList.note Text node with attribution DefinitionObservações 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).
| |
entry | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idList.entry Entries in the list DefinitionEntries in this list. If there are no entries in the list, an emptyReason SHOULD be provided.
|
id | 0..0 | id | There are no (further) constraints on this element Element idList.entry.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.entry.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idList.entry.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
flag | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idList.entry.flag Status/Workflow information about this item DefinitionO elemento flag deve ser preenchido tendo em contexto do valor colocado no elemento List.code. 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. 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". Codes that provide further information about the reason and meaning of the item in the list.
| |
deleted | ?! I | 0..0 | boolean | There are no (further) constraints on this element Element idList.entry.deleted If this item is actually marked as deleted DefinitionIndicação se a entrada foi excluída da lista 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". 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. 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'
|
date | 0..0 | dateTime | There are no (further) constraints on this element Element idList.entry.date When item added to list DefinitionData 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:
The date may be significant for understanding the meaning of items in a working list.
| |
item | I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idList.entry.item Actual entry DefinitionReferência ao recurso elemento da lista 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.
|
emptyReason | I | 0..0 | CodeableConceptPTCoreBinding | There are no (further) constraints on this element Element idList.emptyReason Concept - reference to a terminology or just text DefinitionMotivo 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/ . Allows capturing things like "none exist" or "not asked" which can be important for most lists. 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. If a list is empty, why it is empty.
|
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 |
system
consultar Systems.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.