TreeStudio | Family - SIMPLIFIER.NET

Family (Group)	I		Group	There are no (further) constraints on this element Element id Group Short description Group of multiple entities Definition Represents 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. Comments If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics. Data type Group Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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 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(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() grp-1: Can only have members if group is "actual" `member.empty() or (actual = true)` Mappings rim: Entity. Role, or Act rim: Entity[determinerCode="GRP" or determinerCode="GRP_KIND"]
id	Σ	0..1	string	There are no (further) constraints on this element Element id Group.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 string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Group.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 Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Group.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 `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Group.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 A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Group.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 `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Group.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 Mappings rim: N/A
extension	I	0..*	Extension	Element id Group.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) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
broken	I	0..1	Extension(boolean)	Element id Group.extension:broken Short description Optional Extensions Element Alternate names extensions, user content, broken Definition Optional Extension Element - found in all resources. 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(boolean) Extension URL https://treestudio.healthincode.com/fhir/StructureDefinition/family-broken Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A rim: n/a
consanguineous	I	0..1	Extension(boolean)	Element id Group.extension:consanguineous Short description Optional Extensions Element Alternate names extensions, user content, consanguineous Definition Optional Extension Element - found in all resources. 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(boolean) Extension URL https://treestudio.healthincode.com/fhir/StructureDefinition/family-consanguineous Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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 Group.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 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id Group.identifier Short description Unique id Definition A unique business identifier for this group. Requirements Allows the group to be referenced from external specifications. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier rim: unique(./id[displayable="true" and scope="OBJ"])
active	Σ	0..1	boolean	There are no (further) constraints on this element Element id Group.active Short description Whether this group's record is in active use Definition Indicates whether the record for the group is available for use or is merely being retained for historical purposes. Requirements 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). Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: ./statusCode
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Group.type Short description person \| animal \| practitioner \| device \| medication \| substance Definition Identifies the broad classification of the kind of resources the group includes. Requirements Identifies what type of resources the group is made up of. Comments Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.). Data type code Binding Types of resources that are part of group. GroupType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: person: ./classCode="PSN" animal: ./classCode="ANM" device: ./classCode="DEV" medication: ./classCode="MMAT" and ./playedRole[isNormalRole() and classCode="THER"] food: ./classCode="FOOD"
actual	Σ I	1..1	boolean	There are no (further) constraints on this element Element id Group.actual Short description Descriptive or actual Definition If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. Requirements 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: true: ./determinerCode="GRP" false: ./determinerCode="GRP_KIND"
code	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id Group.code Short description Kind of Group members Definition Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. Comments This would generally be omitted for Person resources. Data type CodeableConcept Binding Kind of particular resource; e.g. cow, syringe, lake, etc. (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: ./code
name	Σ	0..1	string	There are no (further) constraints on this element Element id Group.name Short description Label for Group Definition A label assigned to the group for human identification and communication. Requirements Used to identify the group in human communication. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./name[type="ST"]
quantity	Σ	0..1	unsignedInt	There are no (further) constraints on this element Element id Group.quantity Short description Number of members Definition A count of the number of resource instances that are part of the group. Requirements Group size is a common defining characteristic. Comments Note that the quantity may be less than the number of members if some of the members are not active. Data type unsignedInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./quantity
managingEntity	Σ	0..1	Reference(Organization \| RelatedPerson \| Practitioner \| PractitionerRole)	There are no (further) constraints on this element Element id Group.managingEntity Short description Entity that is the custodian of the Group's definition Definition Entity responsible for defining and maintaining Group characteristics and/or registered members. Comments This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension. Data type Reference(Organization \| RelatedPerson \| Practitioner \| PractitionerRole) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
characteristic		0..*	BackboneElement	There are no (further) constraints on this element Element id Group.characteristic Short description Include / Exclude group members by Trait Definition Identifies traits whose presence r absence is shared by members of the group. Requirements Needs to be a generic mechanism for identifying what individuals can be part of a group. Comments All the identified characteristics must be true for an entity to a member of the group. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode="SBJ"]/act[isNormalAct and classCode="OBS" and moodCode="EVN"]
id		0..1	string	There are no (further) constraints on this element Element id Group.characteristic.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 string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Group.characteristic.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 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Group.characteristic.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 `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
code		1..1	CodeableConcept	There are no (further) constraints on this element Element id Group.characteristic.code Short description Kind of characteristic Definition A code that identifies the kind of trait being asserted. Requirements Need a formal way of identifying the characteristic being described. Data type CodeableConcept Binding List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./code
value[x]		1..1		There are no (further) constraints on this element Element id Group.characteristic.value[x] Short description Value held by characteristic Definition The value of the trait that holds (or does not hold - see 'exclude') for members of the group. Requirements The value of the characteristic is what determines group membership. Comments For Range, it means members of the group have a value that falls somewhere within the specified range. Binding Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./value
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data type CodeableConcept
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueQuantity			Quantity	There are no (further) constraints on this element Data type Quantity
valueRange			Range	There are no (further) constraints on this element Data type Range
valueReference			Reference()	There are no (further) constraints on this element Data type Reference()
exclude		1..1	boolean	There are no (further) constraints on this element Element id Group.characteristic.exclude Short description Group includes or excludes Definition If true, indicates the characteristic is one that is NOT held by members of the group. Requirements Sometimes group membership is determined by characteristics not possessed. Comments This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./valueNegationInd
period		0..1	Period	There are no (further) constraints on this element Element id Group.characteristic.period Short description Period over which characteristic is tested Definition The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
member	I	0..2	BackboneElement	There are no (further) constraints on this element Element id Group.member Short description Who or what is in group Definition Identifies the resource instances that are members of the group. Requirements Often the only thing of interest about a group is "who's in it". Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./scopedRole[isNormalRole() and classCode="MBR"]/player
id		0..1	string	There are no (further) constraints on this element Element id Group.member.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 string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Group.member.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 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Group.member.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 `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
entity		1..1	Reference(individual)	Element id Group.member.entity Short description Reference to the group member Definition A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same. Data type Reference(individual) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
period		0..1	Period	There are no (further) constraints on this element Element id Group.member.period Short description Period member belonged to the group Definition The period that the member was in the group, if known. Requirements Need to track who was in a group at a particular time. Meaning when missing The member is in the group at this time Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
inactive		0..1	boolean	There are no (further) constraints on this element Element id Group.member.inactive Short description If member is no longer in group Definition A flag to indicate that the member is no longer in the group, but previously may have been a member. Requirements Sometimes you don't know when someone stopped being in a group, but not when. Meaning when missing Members are considered active unless explicitly specified otherwise Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

Documentation:

https://simplifier.net/treestudio/family

Last updated on 6/25/2020, 8:54:13 PM

Confirmation

Family

About

Information

Follow us

Links