R6 Ballot (2nd Draft)
AdministrationPublish-box (todo)
| FHIR Infrastructure Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
StructureDefinition for Enforces an enumerated group, rather than a definitional group
{
"resourceType" : "StructureDefinition",
"id" : "actualgroup",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/actualgroup",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.5.1090"
}],
"version" : "6.0.0-ballot2",
"name" : "ActualGroup",
"title" : "Actual Group",
"status" : "draft",
"experimental" : false,
"date" : "2020-12-28T16:55:11+11:00",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
}],
"description" : "Enforces an enumerated group, rather than a definitional group",
"fhirVersion" : "6.0.0-ballot2",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "interface",
"uri" : "http://hl7.org/fhir/interface",
"name" : "Interface Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Group",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Group",
"derivation" : "constraint",
"snapshot" : {
"element" : [{
"id" : "Group",
"path" : "Group",
"short" : "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.",
"comment" : "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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Group",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "cnl-2",
"severity" : "error",
"human" : "Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated'",
"expression" : "Group.type.exists() or (Group.membership = 'conceptual')",
"source" : "http://hl7.org/fhir/StructureDefinition/Group"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "conformance.behavior,administrative.group"
},
{
"identity" : "rim",
"map" : "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
},
{
"identity" : "interface",
"map" : "Participant"
}]
},
{
"id" : "Group.id",
"path" : "Group.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Group.meta",
"path" : "Group.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Group.implicitRules",
"path" : "Group.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "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 its narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary" : true
},
{
"id" : "Group.language",
"path" : "Group.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
}],
"strength" : "required",
"description" : "IETF language tag for a human language",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2",
"additional" : [{
"purpose" : "starter",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}]
}
},
{
"id" : "Group.text",
"path" : "Group.text",
"short" : "Text summary of the resource, for human interpretation",
"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.",
"comment" : "Contained resources do not have a 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.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"condition" : ["dom-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Group.contained",
"path" : "Group.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"comment" : "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.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"condition" : ["dom-2",
"dom-4",
"dom-3",
"dom-5"],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Group.extension",
"path" : "Group.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.",
"comment" : "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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Group.modifierExtension",
"path" : "Group.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Group.url",
"path" : "Group.url",
"short" : "Canonical identifier for this Group, represented as an absolute URI (globally unique)",
"definition" : "An absolute URI that is used to identify this Group when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Group is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Group is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).\n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the Group to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "cnl-1",
"severity" : "warning",
"human" : "URL should not contain | or # - these characters make processing canonical references problematic",
"expression" : "exists() implies matches('^[^|# ]+$')",
"source" : "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Group.identifier",
"path" : "Group.identifier",
"short" : "Business Identifier for this Group",
"definition" : "Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.",
"requirements" : "Allows identification of the group as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
},
{
"identity" : "interface",
"map" : "Participant.identifier"
}]
},
{
"id" : "Group.version",
"path" : "Group.version",
"short" : "Business version of the Group",
"definition" : "The identifier that is used to identify this version of the Group when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Group author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence without additional knowledge.",
"comment" : "There may be different Groups that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the Group with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "Group.versionAlgorithm[x]",
"path" : "Group.versionAlgorithm[x]",
"short" : "How to compare versions",
"definition" : "Indicates the mechanism used to compare versions to determine which is more current.",
"comment" : "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.versionAlgorithm[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
},
{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VersionAlgorithm"
}],
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/ValueSet/version-algorithm"
}
},
{
"id" : "Group.name",
"path" : "Group.name",
"short" : "Label for Group",
"definition" : "A label assigned to the group for human identification and communication.",
"requirements" : "Used to identify the group in human communication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./name[type=\"ST\"]"
},
{
"identity" : "interface",
"map" : "Participant.name"
}]
},
{
"id" : "Group.title",
"path" : "Group.title",
"short" : "Name for this Group (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the Group.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Group.status",
"path" : "Group.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of this Group.",
"comment" : "A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) documentation.\n\nUnknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"requirements" : "Enables tracking the life-cycle of the content and filtering of Groups that are appropriate for use versus not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired Group without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Group.experimental",
"path" : "Group.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this Group is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.",
"comment" : "Allows filtering of Groups that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level Group.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If absent, this resource is treated as though it is not experimental.",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Group.date",
"path" : "Group.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the Group was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Group changes.",
"comment" : "The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Group. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "Group.publisher",
"path" : "Group.publisher",
"short" : "Name of the publisher/steward (organization or individual)",
"definition" : "The name of the organization or individual responsible for the release and ongoing maintenance of the Group.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the Group is the organization or individual primarily responsible for the maintenance and upkeep of the Group. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Group. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the Group. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "Group.contact",
"path" : "Group.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Group.description",
"path" : "Group.description",
"short" : "Natural language description of the group",
"definition" : "Explanation of what the group represents and how it is intended to be used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.useContext",
"path" : "Group.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Groups.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Group.purpose",
"path" : "Group.purpose",
"short" : "Why this Group is defined",
"definition" : "Explanation of why this Group is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the Group. Instead, it provides traceability of \"why\" the resource is either needed or \"why\" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Group.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Group.copyright",
"path" : "Group.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the Group and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Group.",
"comment" : "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the Group and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Group.copyrightLabel",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}],
"path" : "Group.copyrightLabel",
"short" : "Copyright holder and year(s)",
"definition" : "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"comment" : "The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"requirements" : "Defines the content expected to be rendered in all representations of the artifact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.copyrightLabel",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.type",
"path" : "Group.type",
"short" : "person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen",
"definition" : "Identifies the broad classification of the kind of resources the group includes.",
"comment" : "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type.",
"requirements" : "Identifies what type of resources the group is made up of.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupType"
}],
"strength" : "required",
"description" : "Types of resources that are part of group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-type|6.0.0-ballot2"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\""
}]
},
{
"id" : "Group.membership",
"path" : "Group.membership",
"short" : "definitional | conceptual | enumerated",
"definition" : "Basis for membership in the Group:\n\n* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.\n* 'conceptual': The Group.characteristics specified are both necessary and sufficient to determine membership. The 'conceptual' Group is a 'definitional' Group in which the Group.type is not bound to FHIR types.\n* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.",
"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 element.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Group.membership",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"fixedCode" : "enumerated",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupMembershipBasis"
}],
"strength" : "required",
"description" : "The basis for membership in a group",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-membership-basis|6.0.0-ballot2"
}
},
{
"id" : "Group.code",
"path" : "Group.code",
"short" : "Use of the Group (and by implication, kind of members)",
"definition" : "A code that describes the use of the group. The use of the group usually dictates what kind of entities can be members of the group.",
"comment" : "The types of entities that can be members needs to align with Group.type",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupCode"
}],
"strength" : "extensible",
"description" : "A code that describes the kind of group, which usually dictates what kind if entities can be in the group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "Group.quantity",
"path" : "Group.quantity",
"short" : "Number of members",
"definition" : "A count of the number of resource instances that are part of the group.",
"comment" : "Note that the quantity may be less than the number of members if some of the members are not active.",
"requirements" : "Group size is a common defining characteristic.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./quantity"
}]
},
{
"id" : "Group.managingEntity",
"path" : "Group.managingEntity",
"short" : "Entity that is the custodian of the Group's definition",
"definition" : "Entity responsible for defining and maintaining Group characteristics and/or registered members.",
"comment" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.managingEntity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "Group.combinationMethod",
"path" : "Group.combinationMethod",
"short" : "all-of | any-of | at-least | at-most | except-subset",
"definition" : "Used to specify how two or more characteristics are combined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.combinationMethod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Changing the combinationMethod from all-of to any other value changes the interpretation of multiple characteristics.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CharacteristicCombination"
}],
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-characteristic-combination|6.0.0-ballot2"
}
},
{
"id" : "Group.combinationThreshold",
"path" : "Group.combinationThreshold",
"short" : "Provides the value of \"n\" when \"at-least\" or \"at-most\" codes are used",
"definition" : "Provides the value of \"n\" when \"at-least\" or \"at-most\" codes are used for combinationMethod.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.combinationThreshold",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.characteristic",
"path" : "Group.characteristic",
"short" : "Include / Exclude group members by Trait",
"definition" : "Identifies traits whose presence r absence is shared by members of the group.",
"comment" : "All the identified characteristics must be true for an entity to a member of the group.",
"requirements" : "Needs to be a generic mechanism for identifying what individuals can be part of a group.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.characteristic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}]
},
{
"id" : "Group.characteristic.id",
"path" : "Group.characteristic.id",
"representation" : ["xmlAttr"],
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Group.characteristic.extension",
"path" : "Group.characteristic.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"comment" : "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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Group.characteristic.modifierExtension",
"path" : "Group.characteristic.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Group.characteristic.code",
"path" : "Group.characteristic.code",
"short" : "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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Group.characteristic.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupCharacteristicKind"
}],
"strength" : "example",
"description" : "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc."
},
"mapping" : [{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "Group.characteristic.value[x]",
"path" : "Group.characteristic.value[x]",
"short" : "Value held by characteristic",
"definition" : "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comment" : "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"requirements" : "The value of the characteristic is what determines group membership.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Group.characteristic.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "boolean"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Reference"
},
{
"code" : "uri"
},
{
"code" : "Expression"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupCharacteristicValue"
}],
"strength" : "example",
"description" : "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc."
},
"mapping" : [{
"identity" : "rim",
"map" : "./value"
}]
},
{
"id" : "Group.characteristic.exclude",
"path" : "Group.characteristic.exclude",
"short" : "Group includes or excludes",
"definition" : "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comment" : "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"requirements" : "Sometimes group membership is determined by characteristics not possessed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Group.characteristic.exclude",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./valueNegationInd"
}]
},
{
"id" : "Group.characteristic.description",
"path" : "Group.characteristic.description",
"short" : "Natural language description of the characteristic",
"definition" : "A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.",
"requirements" : "Need to be able to describe characteristics in natural language so that end users can understand the criteria.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.characteristic.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.characteristic.method",
"path" : "Group.characteristic.method",
"short" : "Method for how the characteristic value was determined",
"definition" : "Method for how the characteristic value was determined.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.characteristic.method",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionMethod"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-method"
}
},
{
"id" : "Group.characteristic.determinedBy[x]",
"path" : "Group.characteristic.determinedBy[x]",
"short" : "Defines the characteristic",
"definition" : "Defines the characteristic (without using type and value) by either a Reference or an Expression.",
"requirements" : "The value of the characteristic is what determines group membership.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.characteristic.determinedBy[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceDefinition",
"http://hl7.org/fhir/StructureDefinition/DeviceMetric"]
},
{
"code" : "Expression"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.characteristic.offset",
"path" : "Group.characteristic.offset",
"short" : "Reference point for comparison",
"definition" : "Defines the reference point for comparison when other than 0.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.characteristic.offset",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "If offset is present it must be included to interpret the characteristic value.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CharacteristicOffset"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/characteristic-offset"
}
},
{
"id" : "Group.characteristic.instances[x]",
"path" : "Group.characteristic.instances[x]",
"short" : "Number of occurrences meeting the characteristic",
"definition" : "Number of occurrences meeting the characteristic.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.characteristic.instances[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.characteristic.duration[x]",
"path" : "Group.characteristic.duration[x]",
"short" : "Length of time in which the characteristic is met",
"definition" : "Length of time in which the characteristic is met.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.characteristic.duration[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.characteristic.period",
"path" : "Group.characteristic.period",
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.characteristic.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.characteristic.timing",
"path" : "Group.characteristic.timing",
"short" : "Timing in which the characteristic is determined",
"definition" : "Timing in which the characteristic is determined.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.characteristic.timing",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelativeTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.member",
"path" : "Group.member",
"short" : "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\".",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.member",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}]
},
{
"id" : "Group.member.id",
"path" : "Group.member.id",
"representation" : ["xmlAttr"],
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Group.member.extension",
"path" : "Group.member.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"comment" : "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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Group.member.modifierExtension",
"path" : "Group.member.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"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](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Group.member.entity",
"path" : "Group.member.entity",
"short" : "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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Group.member.entity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.member.involvement",
"path" : "Group.member.involvement",
"short" : "Code that describes how user is part of the group",
"definition" : "A code that describes how a user is involved in the group. Some groups (e.g. exposure-group) typically don't have variance between members, or it is not tracked, while for other groups (e.g. family, household) this may be meaningful.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Group.member.involvement",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupInvolvement"
}],
"strength" : "example",
"description" : "A code that describes how a user is involved in the group",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-involvement-set"
}
},
{
"id" : "Group.member.period",
"path" : "Group.member.period",
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.member.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"meaningWhenMissing" : "The member is in the group at this time",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Group.member.inactive",
"path" : "Group.member.inactive",
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Group.member.inactive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Members are considered active unless explicitly specified otherwise",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "Group",
"path" : "Group",
"min" : 1,
"max" : "1"
},
{
"id" : "Group.membership",
"path" : "Group.membership",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"fixedCode" : "enumerated"
}]
}
}
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Mon, Aug 12, 2024 16:58+0800.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change