FHIR CI-Build
AdministrationThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Patient, Practitioner |
This is a representation of the json schema for Group, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/Group",
"$ref": "#/definitions/Group",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Group": {
"description": "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\u0027t an Organization.",
"properties": {
"resourceType": {
"description": "This is a Group resource",
"const": "Group"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"name": {
"description": "A label assigned to the group for human identification and communication.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the Group.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The current state of this Group.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "A Boolean value to indicate that this Group is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the Group.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "Explanation of what the group represents and how it is intended to be used.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the {{title}} is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this Group is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "Identifies the broad classification of the kind of resources the group includes.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"membership": {
"description": "Basis for membership in the Group:\n\n* \u0027definitional\u0027: 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* \u0027conceptual\u0027: The Group.characteristics specified are both necessary and sufficient to determine membership. The \u0027conceptual\u0027 Group is a \u0027definitional\u0027 Group in which the Group.type is not bound to FHIR types.\n* \u0027enumerated\u0027: The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.",
"$ref": "#/definitions/code"
},
"_membership": {
"description": "Extensions for membership",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"quantity": {
"description": "A count of the number of resource instances that are part of the group.",
"$ref": "#/definitions/unsignedInt"
},
"_quantity": {
"description": "Extensions for quantity",
"$ref": "Element.schema.json#/definitions/Element"
},
"managingEntity": {
"description": "Entity responsible for defining and maintaining Group characteristics and/or registered members.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"combinationMethod": {
"description": "Used to specify how two or more characteristics are combined.",
"$ref": "#/definitions/code"
},
"_combinationMethod": {
"description": "Extensions for combinationMethod",
"$ref": "Element.schema.json#/definitions/Element"
},
"combinationThreshold": {
"description": "Provides the value of \"n\" when \"at-least\" or \"at-most\" codes are used for combinationMethod.",
"$ref": "#/definitions/positiveInt"
},
"_combinationThreshold": {
"description": "Extensions for combinationThreshold",
"$ref": "Element.schema.json#/definitions/Element"
},
"characteristic": {
"description": "Identifies traits whose presence r absence is shared by members of the group.",
"items": {
"$ref": "#/definitions/Group_Characteristic"
},
"type": "array"
},
"member": {
"description": "Identifies the resource instances that are members of the group.",
"items": {
"$ref": "#/definitions/Group_Member"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Group_Characteristic": {
"description": "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\u0027t an Organization.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A code that identifies the kind of trait being asserted.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueCodeableConcept": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueBoolean": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueQuantity": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueRange": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueReference": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"valueUri": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueExpression": {
"description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"exclude": {
"description": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"$ref": "#/definitions/boolean"
},
"_exclude": {
"description": "Extensions for exclude",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"method": {
"description": "Method for how the characteristic value was determined.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"determinedByReference": {
"description": "Defines the characteristic (without using type and value) by either a Reference or an Expression.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"determinedByExpression": {
"description": "Defines the characteristic (without using type and value) by either a Reference or an Expression.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"offset": {
"description": "Defines the reference point for comparison when other than 0.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"instancesQuantity": {
"description": "Number of occurrences meeting the characteristic.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"instancesRange": {
"description": "Number of occurrences meeting the characteristic.",
"$ref": "Range.schema.json#/definitions/Range"
},
"durationDuration": {
"description": "Length of time in which the characteristic is met.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"durationRange": {
"description": "Length of time in which the characteristic is met.",
"$ref": "Range.schema.json#/definitions/Range"
},
"period": {
"description": "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.",
"$ref": "Period.schema.json#/definitions/Period"
},
"timing": {
"description": "Timing in which the characteristic is determined.",
"items": {
"$ref": "RelativeTime.schema.json#/definitions/RelativeTime"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code"
]
},
"Group_Member": {
"description": "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\u0027t an Organization.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"entity": {
"description": "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.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"involvement": {
"description": "A code that describes how a user is involved in the group. Some groups (e.g. exposure-group) typically don\u0027t have variance between members, or it is not tracked, while for other groups (e.g. family, household) this may be meaningful.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"period": {
"description": "The period that the member was in the group, if known.",
"$ref": "Period.schema.json#/definitions/Period"
},
"inactive": {
"description": "A flag to indicate that the member is no longer in the group, but previously may have been a member.",
"$ref": "#/definitions/boolean"
},
"_inactive": {
"description": "Extensions for inactive",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"entity"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Wed, Nov 20, 2024 21:52+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change