MyGroupSGES (Group) | I | Group | There are no (further) constraints on this element Element idGroup Group of multiple entities DefinitionRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.
| |
id | Σ | 1..1 | id | There are no (further) constraints on this element Element idGroup.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 | Meta | There are no (further) constraints on this element Element idGroup.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idGroup.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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idGroup.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). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idGroup.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 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. 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.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idGroup.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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idGroup.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. 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. 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 idGroup.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. 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. 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..* | Identifier | There are no (further) constraints on this element Element idGroup.identifier Unique id DefinitionA unique business identifier for this group. Allows the group to be referenced from external specifications.
|
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idGroup.active Whether this group's record is in active use DefinitionIndicates whether the record for the group is available for use or is merely being retained for historical purposes. Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).
true
|
type | Σ | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idGroup.type person | animal | practitioner | device | medication | substance DefinitionIdentifies the broad classification of the kind of resources the group includes. Identifies what type of resources the group is made up of. Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medicaiton or Substance for the other types.). Types of resources that are part of group GroupType (required)Constraints
person
|
actual | Σ I | 1..1 | boolean | There are no (further) constraints on this element Element idGroup.actual Descriptive or actual DefinitionIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.
|
code | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idGroup.code Kind of Group members DefinitionProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc. This would generally be omitted for Person resources. Kind of particular resource; e.g. cow, syringe, lake, etc. (unbound) (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idGroup.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idGroup.code.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. 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. 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
|
coding | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idGroup.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
id | 0..1 | string | There are no (further) constraints on this element Element idGroup.code.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idGroup.code.coding.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. 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. 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
|
system | Σ | 0..1 | uriFixed Value | There are no (further) constraints on this element Element idGroup.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
http://spms.min-saude.pt/sges/codesystem/group-type
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idGroup.code.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idGroup.code.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idGroup.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idGroup.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idGroup.code.text Plain text representation of the concept DefinitionA 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. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idGroup.name Label for Group DefinitionA label assigned to the group for human identification and communication. Used to identify the group in human communication. Note that FHIR strings may not exceed 1MB in size
|
quantity | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idGroup.quantity Number of members DefinitionA count of the number of resource instances that are part of the group. Group size is a common defining characteristic. Note that the quantity may be less than the number of members if some of the members are not active.
|
characteristic | 0..* | BackboneElement | There are no (further) constraints on this element Element idGroup.characteristic Trait of group members DefinitionIdentifies the traits shared by members of the group. Needs to be a generic mechanism for identifying what individuals can be part of a group. All the identified characteristics must be true for an entity to a member of the group.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idGroup.characteristic.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idGroup.characteristic.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. 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. 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 idGroup.characteristic.modifierExtension Extensions that cannot be ignored 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 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. 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.
|
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idGroup.characteristic.code Kind of characteristic DefinitionA code that identifies the kind of trait being asserted. Need a formal way of identifying the characteristic being described. 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. List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. (unbound) (example)Constraints
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idGroup.characteristic.value[x] Value held by characteristic DefinitionThe value of the trait that holds (or does not hold - see 'exclude') for members of the group. The value of the characteristic is what determines group membership. For Range, it means members of the group have a value that falls somewhere within the specified range. Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. (unbound) (example)Constraints
| ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
exclude | ?! | 1..1 | boolean | There are no (further) constraints on this element Element idGroup.characteristic.exclude Group includes or excludes DefinitionIf true, indicates the characteristic is one that is NOT held by members of the group. Sometimes group membership is determined by characteristics not possessed. This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.
|
period | I | 0..1 | Period | There are no (further) constraints on this element Element idGroup.characteristic.period Period over which characteristic is tested DefinitionThe period over which the characteristic is tested; e.g. the patient had an operation during the month of June. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
member | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idGroup.member Who or what is in group DefinitionIdentifies the resource instances that are members of the group. Often the only thing of interest about a group is "who's in it".
|
id | 0..1 | string | There are no (further) constraints on this element Element idGroup.member.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idGroup.member.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. 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. 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
|
extension-tax-position | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idGroup.member.extension:extension-tax-position Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://spms.min-saude.pt/sges/extensions/tax-position Constraints
|
extension-shareholder-share | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idGroup.member.extension:extension-shareholder-share Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://spms.min-saude.pt/sges/extensions/shareholder-share Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idGroup.member.modifierExtension Extensions that cannot be ignored 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 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. 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.
|
entity | I | 1..1 | Reference(MyPractitionerSGES) | There are no (further) constraints on this element Element idGroup.member.entity Reference to the group member DefinitionA reference to the entity that is a member of the group. Must be consistent with Group.type. 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. Allowed aggregation: bundled, referenced Constraints
|
period | I | 0..1 | Period | There are no (further) constraints on this element Element idGroup.member.period Period member belonged to the group DefinitionThe period that the member was in the group, if known. Need to track who was in a group at a particular time. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The member is in the group at this time
|
inactive | 0..1 | boolean | There are no (further) constraints on this element Element idGroup.member.inactive If member is no longer in group DefinitionA flag to indicate that the member is no longer in the group, but previously may have been a member. Sometimes you don't know when someone stopped being in a group, but not when.
false
|
Group | 0..* | |
Group.id | id | 1..1 |
Group.meta | Meta | 0..1 |
Group.implicitRules | uri | 0..1 |
Group.language | code | 0..1 |
Group.text | Narrative | 0..1 |
Group.contained | Resource | 0..* |
Group.extension | Extension | 0..* |
Group.modifierExtension | Extension | 0..* |
Group.identifier | Identifier | 0..* |
Group.active | boolean | 0..1 |
Group.type | code | 1..1 |
Group.actual | boolean | 1..1 |
Group.code | CodeableConcept | 0..1 |
Group.code.id | string | 0..1 |
Group.code.extension | Extension | 0..* |
Group.code.coding | Coding | 0..1 |
Group.code.coding.id | string | 0..1 |
Group.code.coding.extension | Extension | 0..* |
Group.code.coding.system | uri | 0..1 |
Group.code.coding.version | string | 0..1 |
Group.code.coding.code | code | 0..1 |
Group.code.coding.display | string | 0..1 |
Group.code.coding.userSelected | boolean | 0..1 |
Group.code.text | string | 0..1 |
Group.name | string | 0..1 |
Group.quantity | unsignedInt | 0..1 |
Group.characteristic | BackboneElement | 0..* |
Group.characteristic.id | string | 0..1 |
Group.characteristic.extension | Extension | 0..* |
Group.characteristic.modifierExtension | Extension | 0..* |
Group.characteristic.code | CodeableConcept | 1..1 |
Group.characteristic.value[x] | CodeableConcept, boolean, Quantity, Range | 1..1 |
Group.characteristic.exclude | boolean | 1..1 |
Group.characteristic.period | Period | 0..1 |
Group.member | BackboneElement | 0..* |
Group.member.id | string | 0..1 |
Group.member.extension | Extension | 0..* |
Group.member.extension | Extension | 0..1 |
Group.member.extension | Extension | 0..1 |
Group.member.modifierExtension | Extension | 0..* |
Group.member.entity | Reference(MyPractitionerSGES) | 1..1 |
Group.member.period | Period | 0..1 |
Group.member.inactive | boolean | 0..1 |