Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
- AuditEvent
- BodyStructure
- Bundle
- UKCore-Composition
- UKCore-Condition
- Consent
- UKCore-DiagnosticReport
- DocumentReference
- UKCore-FamilyMemberHistory
- Group
- UKCore-Observation
- OperationOutcome
- UKCore-Organization
- UKCore-Patient
- UKCore-Practitioner
- UKCore-PractitionerRole
- UKCore-Procedure
- Provenance
- Questionnaire
- QuestionnaireResponse
- UKCore-RelatedPerson
- RequestGroup
- ResearchSubject
- UKCore-ServiceRequest
- UKCore-Specimen
- Subscription
- Task
- PlanDefinition
- ActivityDefinition
- Library
- SpecimenDefinition
- All Profiles
- AuditEvent
- BodyStructure
- Bundle
- UKCore-Composition
- UKCore-Condition
- Consent
- UKCore-DiagnosticReport
- DocumentReference
- UKCore-FamilyMemberHistory
- Group
- UKCore-Observation
- OperationOutcome
- UKCore-Organization
- UKCore-Patient
- UKCore-Practitioner
- UKCore-PractitionerRole
- UKCore-Procedure
- Provenance
- Questionnaire
- QuestionnaireResponse
- UKCore-RelatedPerson
- RequestGroup
- ResearchSubject
- UKCore-ServiceRequest
- UKCore-Specimen
- Subscription
- Task
- PlanDefinition
- ActivityDefinition
- Library
- SpecimenDefinition
StructureDefinition AuditEvent
Created by the central GMS infrastructure on any CRUD event.
Can be searched on for auditability and obtaining status history for Tasks (as an alternative to the Task _history option).
It is not expected or permitted that a client system would update or post AuditEvents to the central service.
AuditEvents are expected to be created for any CRUD events which affect resources on the server. Where resources do not exist on the server, e.g. empty SearchSets or failed POSTs, no AuditEvents will be created. Failed updates may still trigger creation of AuditEvent resources but the outcome.code will record that the event was unsuccessful.
AuditEvents for resources created by the server will record the server identity within the who element.
The below profile is therefore provided to support parsing for clients if returned through a GET request.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/AuditEvent | HL7 International | trial-use |
| AuditEvent | C | DomainResource | Element idAuditEventShort description Event record kept for security purposes DefinitionA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Based on IHE-ATNA.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAuditEvent.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAuditEvent.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idAuditEvent.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idAuditEvent.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | CodingBinding | Element idAuditEvent.typeShort description Type/identifier of event DefinitionIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Type of event. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subtype | Σ | 0..* | CodingBinding | Element idAuditEvent.subtypeShort description More specific type/id for the event DefinitionIdentifier for the category of event. This field enables queries of messages by implementation-defined event categories. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Sub-type of event. AuditEventSub-Type (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| action | Σ | 0..1 | codeBinding | Element idAuditEvent.actionShort description Type of action performed during the event DefinitionIndicator for type of action performed during the event that generated the audit. This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. Note that FHIR strings SHALL NOT exceed 1MB in size Indicator for type of action performed during the event that generated the event. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | C | 0..1 | Period | Element idAuditEvent.periodShort description When the activity occurred DefinitionThe period during which the activity occurred. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| recorded | Σ | 1..1 | instant | Element idAuditEvent.recordedShort description Time when the event was recorded DefinitionThe time when the event was recorded. This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution. In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| outcome | Σ | 0..1 | codeBinding | Element idAuditEvent.outcomeShort description Whether the event succeeded or failed DefinitionIndicates whether the event succeeded or failed. In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant. Indicates whether the event succeeded or failed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| outcomeDesc | Σ | 0..1 | string | Element idAuditEvent.outcomeDescShort description Description of the event outcome DefinitionA free text description of the outcome of the event. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purposeOfEvent | Σ | 0..* | CodeableConceptBinding | Element idAuditEvent.purposeOfEventShort description The purposeOfUse of the event DefinitionThe purposeOfUse (reason) that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. The reason the activity took place. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| agent | 1..* | BackboneElement | Element idAuditEvent.agentShort description Actor involved in the event Alternate namesActiveParticipant DefinitionAn actor taking an active role in the event or activity that is logged. An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 0..1 | CodeableConceptBinding | Element idAuditEvent.agent.typeShort description How agent participated DefinitionSpecification of the participation type the user plays when performing the event. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The Participation type of the agent to the event. ParticipationRoleType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| role | 0..* | CodeableConcept | Element idAuditEvent.agent.roleShort description Agent role in the event DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories. Should be roles relevant to the event. Should not be an exhaustive list of roles. What security role enabled the agent to participate in the event. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| who | Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idAuditEvent.agent.whoShort description Identifier of who Alternate namesuserId DefinitionReference to who this agent is that was involved in the event. This field ties an audit event to a specific resource or identifier. Where a User ID is available it will go into who.identifier. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| altId | 0..1 | string | Element idAuditEvent.agent.altIdShort description Alternative User identity DefinitionAlternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available. In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| name | 0..1 | string | Element idAuditEvent.agent.nameShort description Human friendly name for the agent DefinitionHuman-meaningful name for the agent. The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| requestor | Σ | 1..1 | boolean | Element idAuditEvent.agent.requestorShort description Whether user is initiator DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited. This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user. There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | C | 0..1 | Reference(Location) | Element idAuditEvent.agent.locationShort description Where DefinitionWhere the event occurred. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| policy | 0..* | uri | Element idAuditEvent.agent.policyShort description Policy that authorized event DefinitionThe policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. This value is used retrospectively to determine the authorization policies. For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| media | 0..1 | CodingBinding | Element idAuditEvent.agent.mediaShort description Type of media DefinitionType of media involved. Used when the event is about exporting/importing onto media. Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD). Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Used when the event is about exporting/importing onto media. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| network | 0..1 | BackboneElement | Element idAuditEvent.agent.networkShort description Logical network location for application activity DefinitionLogical network location for application activity, if the activity has a network location. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | 0..1 | string | Element idAuditEvent.agent.network.addressShort description Identifier for the network access point of the user device DefinitionAn identifier for the network access point of the user device for the audit event. This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers. This could be a device id, IP address or some other identifier associated with a device. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | 0..1 | codeBinding | Element idAuditEvent.agent.network.typeShort description The type of network access point DefinitionAn identifier for the type of network access point that originated the audit event. This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type. Note that FHIR strings SHALL NOT exceed 1MB in size The type of network access point of this agent in the audit event. AuditEventAgentNetworkType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| purposeOfUse | 0..* | CodeableConceptBinding | Element idAuditEvent.agent.purposeOfUseShort description Reason given for this user DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. The reason the activity took place. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| source | 1..1 | BackboneElement | Element idAuditEvent.sourceShort description Audit Event Reporter DefinitionThe system that is reporting the event. The event is reported by one source. Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| site | 0..1 | string | Element idAuditEvent.source.siteShort description Logical source location within the enterprise DefinitionLogical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. This value differentiates among the sites in a multi-site enterprise health information system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| observer | Σ C | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idAuditEvent.source.observerShort description The identity of source detecting the event Alternate namesSourceId DefinitionIdentifier of the source where the event was detected. This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 0..* | CodingBinding | Element idAuditEvent.source.typeShort description The type of source where event originated DefinitionCode specifying the type of source where event originated. This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Code specifying the type of system that detected and recorded the event. AuditEventSourceType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| entity | C | 0..* | BackboneElement | Element idAuditEvent.entityShort description Data or objects used Alternate namesParticipantObject DefinitionSpecific instances of data or objects that have been accessed. The event may have other entities involved. Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| what | Σ C | 0..1 | Reference(Resource) | Element idAuditEvent.entity.whatShort description Specific instance of resource DefinitionIdentifies a specific instance of the entity. The reference should be version specific. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 0..1 | CodingBinding | Element idAuditEvent.entity.typeShort description Type of entity involved DefinitionThe type of the object that was involved in this audit event. To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action. This value is distinct from the user's role or any user relationship to the entity. Code for the entity type involved in the audit event. AuditEventEntityType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| role | 0..1 | CodingBinding | Element idAuditEvent.entity.roleShort description What role the entity played DefinitionCode representing the role the entity played in the event being audited. For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| lifecycle | 0..1 | CodingBinding | Element idAuditEvent.entity.lifecycleShort description Life-cycle stage for the entity DefinitionIdentifier for the data life-cycle stage for the entity. Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases. This can be used to provide an audit trail for data, over time, as it passes through the system. Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| securityLabel | 0..* | CodingBinding | Element idAuditEvent.entity.securityLabelShort description Security labels on the entity DefinitionSecurity labels for the identified entity. This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues. Copied from entity meta security tags. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| name | Σ C | 0..1 | string | Element idAuditEvent.entity.nameShort description Descriptor for entity DefinitionA name of the entity in the audit event. Use only where entity can't be identified with an identifier. This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used. The cardinality or value of this element may be affected by these constraints: ele-1, sev-1 Constraints
| ||
| description | 0..1 | string | Element idAuditEvent.entity.descriptionShort description Descriptive text DefinitionText that describes the entity in more detail. Use only where entity can't be identified with an identifier. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| query | Σ C | 0..1 | base64Binary | Element idAuditEvent.entity.queryShort description Query parameters DefinitionThe query parameters for a query-type entities. For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. The cardinality or value of this element may be affected by these constraints: ele-1, sev-1 Constraints
| ||
| detail | 0..* | BackboneElement | Element idAuditEvent.entity.detailShort description Additional Information about the entity DefinitionTagged value pairs for conveying additional information about the entity. Implementation-defined data about specific details of the object accessed or used. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 1..1 | string | Element idAuditEvent.entity.detail.typeShort description Name of the property DefinitionThe type of extra detail provided in the value. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| value[x] | 1..1 | Element idAuditEvent.entity.detail.value[x]Short description Property value DefinitionThe value of the extra detail. Should not duplicate the entity value unless absolutely necessary. The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueBase64Binary | base64Binary | Data type | ||||
| valueString | string | Data type |
Additional Guidance
action
SHALL be present. Code from base HL7 resource, only C (create), R (read) and U (update) would usually be expected."action": "U",
agent
SHOULD be present for any user initiated actions. Reference to the user or system that triggered the creation/read/update. Identity SHOULD be determined through the appropriate authentication token within the request header, e.g. CIS2 auth token."agent": [ { "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "AUT", "display": "author (originator)" } ] }, "who": { "reference": "PractitionerRole/PractitionerRole-TestClinicalScientist-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "9999999997" } }, "name": "Test Clinical Scientist", "requestor": true } ],
entity
SHOULD be present where the resource exists on the server. Reference to the resource which was affected by the event."entity": [ { "what": { "reference": "Task/Task-NonWGSRareDiseaseTestOrderRejected-Example" }, "type": { "system": "http://hl7.org/fhir/resource-types", "code": "Task", "display": "Task" }, "role": { "system": "http://terminology.hl7.org/CodeSystem/object-role", "code": "20", "display": "Job" } } ]
StructureDefinition BodyStructure
The Genomics BodyStructure is currently based on the HL7 international version of the resource as a profile for BodyStructure does not exist in UKCore. Once this profile becomes active in UKCore its suitability for use and need for profiling within Genomics will be assessed.
The base BodyStructure resource is provided below for completeness.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/BodyStructure | HL7 International | trial-use |
Usage
Use of this resource is meant to replace the Genomics extensions for topology and morphology on the Specimen profile| BodyStructure | C | DomainResource | Element idBodyStructureShort description Specific and identified anatomical structure Alternate namesanatomical location DefinitionRecord details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idBodyStructure.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBodyStructure.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBodyStructure.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBodyStructure.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idBodyStructure.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idBodyStructure.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBodyStructure.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBodyStructure.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idBodyStructure.identifierShort description Bodystructure identifier DefinitionIdentifier for this instance of the anatomical structure. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 0..1 | boolean | Element idBodyStructure.activeShort description Whether this record is in active use DefinitionWhether this body site is in active use. Need to be able to mark a body site entry as not to be used because it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| morphology | Σ | 0..1 | CodeableConcept | Element idBodyStructure.morphologyShort description Kind of Structure DefinitionThe kind of structure being represented by the body structure at The minimum cardinality of 0 supports the use case of specifying a location without defining a morphology. Codes describing anatomic morphology. SNOMEDCTMorphologicAbnormalities (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ | 0..1 | CodeableConcept | Element idBodyStructure.locationShort description Body site DefinitionThe anatomical location or region of the specimen, lesion, or body structure. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationQualifier | 0..* | CodeableConcept | Element idBodyStructure.locationQualifierShort description Body site modifier DefinitionQualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Concepts modifying the anatomic location. BodystructureLocationQualifier (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| description | Σ | 0..1 | string | Element idBodyStructure.descriptionShort description Text description DefinitionA summary, characterization or explanation of the body structure. This description could include any visual markings used to orientate the viewer e.g. external reference points, special sutures, ink markings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| image | C | 0..* | Attachment | Element idBodyStructure.imageShort description Attached images DefinitionImage or images used to identify a location. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| patient | Σ C | 1..1 | Reference(Patient) | Element idBodyStructure.patientShort description Who this is about DefinitionThe person to which the body site belongs. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| BodyStructure.morphology | PS-17 - Primary Sample - Solid tumour morphology | Additional SPM-4/5 qualifiers |
| BodyStructure.location | PS-18 - Primary Sample - Solid tumour histological type (topography) | SPM-8 |
StructureDefinition Bundle
The Genomics Bundle resource is currently based on the core HL7 resource, without any need for profiling.
The base R4 Bundle is provided below for completeness.
Bundles within Genomics will be limited to Transactions for Test orders and updates; Transaction-responses for responses to transactions (housing sets of OperationOutcomes); or Searchsets, returned in response to search queries.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Bundle | HL7 International | trial-use |
| Bundle | C | Resource | Element idBundleShort description Contains a collection of resources DefinitionA container for a collection of resources.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBundle.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBundle.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| identifier | Σ | 0..1 | Identifier | Element idBundle.identifierShort description Persistent identifier for the bundle DefinitionA persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | codeBinding | Element idBundle.typeShort description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection DefinitionIndicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Indicates the purpose of a bundle - how it is intended to be used. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| timestamp | Σ | 0..1 | instant | Element idBundle.timestampShort description When the bundle was assembled DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| total | Σ C | 0..1 | unsignedInt | Element idBundle.totalShort description If search, the total number of matches DefinitionIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-1 Constraints
| ||
| link | Σ | 0..* | BackboneElement | Element idBundle.linkShort description Links related to this Bundle DefinitionA series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.link.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.link.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.link.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relation | Σ | 1..1 | string | Element idBundle.link.relationShort description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 DefinitionA name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 1..1 | uri | Element idBundle.link.urlShort description Reference details for the link DefinitionThe reference details for the link. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| entry | Σ C | 0..* | BackboneElement | Element idBundle.entryShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. | ||
| fullUrl | Σ | 0..1 | uri | Element idBundle.entry.fullUrlShort description URI for resource (Absolute URL server address or URI for UUID/OID) DefinitionThe Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| resource | Σ | 0..1 | Resource | Element idBundle.entry.resourceShort description A resource in the bundle DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
| ||
| search | Σ C | 0..1 | BackboneElement | Element idBundle.entry.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-2 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| mode | Σ | 0..1 | codeBinding | Element idBundle.entry.search.modeShort description match | include | outcome - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| score | Σ | 0..1 | decimal | Element idBundle.entry.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| request | Σ C | 0..1 | BackboneElement | Element idBundle.entry.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-3 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| method | Σ | 1..1 | codeBinding | Element idBundle.entry.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1MB in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 1..1 | uri | Element idBundle.entry.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifNoneMatch | Σ | 0..1 | string | Element idBundle.entry.request.ifNoneMatchShort description For managing cache currency DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifModifiedSince | Σ | 0..1 | instant | Element idBundle.entry.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifMatch | Σ | 0..1 | string | Element idBundle.entry.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ifNoneExist | Σ | 0..1 | string | Element idBundle.entry.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| response | Σ C | 0..1 | BackboneElement | Element idBundle.entry.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: ele-1, bdl-4 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ | 1..1 | string | Element idBundle.entry.response.statusShort description Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ | 0..1 | uri | Element idBundle.entry.response.locationShort description The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| etag | Σ | 0..1 | string | Element idBundle.entry.response.etagShort description The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| lastModified | Σ | 0..1 | instant | Element idBundle.entry.response.lastModifiedShort description Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| outcome | Σ | 0..1 | Resource | Element idBundle.entry.response.outcomeShort description OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
| ||
| signature | Σ | 0..1 | Signature | Element idBundle.signatureShort description Digital Signature DefinitionDigital Signature - base64 encoded. XML-DSig or a JWT. A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
- Bundle-NonWGSTestOrderForm-CancerSolidTumor-Example
- Bundle-NonWGSTestOrderForm-Example
- Bundle-NonWGSTestOrderForm-FetalScenario-Example
- Bundle-NonWGSTestOrderForm-Reanalysis-Example
- Bundle-WGSRoD-Example
- Bundle-WGSTestOrderForm-Example
- Bundle-TransactionResponseError-Example
- Bundle-TransactionResponseSuccess-Example
- Bundle-Searchset-Example
Additional Guidance
type
SHALL be present. The type of Bundle. This is expected to be `transaction` for Bundles POSTed to the central broker, `transaction-response` for responses to transaction Bundles returned by the broker and `searchset` for collections of resources returned in response to search (GET) requests, as per standard HTTP FHIR rules."type": "transaction",
total
Only relevant for searchset Bundles. Details the number of resources in the bundle matching the search criteria, not including resources included via the _include criteria.
"total": 3,
link
Only relevant for searchset bundles. Details the query string that resulted in the searchset (to allow future queries using the same parameters). `"relation": "self"` will only ever be used.Links related to response pagination such as next/prev are pending Non-Functional Requirements finalisation for the order management central broker.
"link": [ { "relation": "self", "url": "https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Specimen/?_include=Specimen%3Asubject&identifier=RGT03135" } ],
entry
Transactions
An entry in the bundle. For transaction Bundles, each entry SHOULD contain a fullURL to ensure resources in the Bundle can reference each other, these can be the locations within the source system or urn:uuids.
Resources are expected to contain ids to allow referencing within Bundles, though these will be replaced by server assigned ids when saved by the central broker. If additional identifiers need to be persisted e.g. NHS Number, these should be captured within the identifier field.
Transaction Bundle entries also SHALL contain a request object, specifying the method (either PUT for updates or POST for creates) and the url to send the resource to (equivalent to the resource type for the resource).
Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS
"entry": [ { "fullUrl": "http://example.org/fhir/Specimen/Specimen-BloodEDTA-Example", "resource": { "resourceType": "Specimen", "id": "Specimen-BloodEDTA-Example", "identifier": [ { "system": "https://fhir.add.nhs.uk/Id/specimenId", "value": "RGT03135" } ], "status": "unavailable", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "445295009", "display": "Blood specimen with EDTA" } ] }, "subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } }, "request": [ { "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-Example" } ] }, "request": { "method": "POST", "url": "Specimen" } } ]
Transaction Responses
These Bundles are returned in response to transaction requests. These will only contain OperationOutcome resources (one for each recource contained in the transaction request). See Acknowledgements and responses for more information.
These entries will contain a response object detailing the response status of the individual resource operation and an OperationOutcome detailing any relevant diagnostics, such as validation messages.
Entries will also contain a location element, detailing the relative path of the resource, where the operation has resulted in a resource being created or updated. These URLs will be version specific (using the _history suffix to denote the version number of the resource) if the resource has been updated.
"entry": [ { "response": { "status": "201 Created", "location": "ServiceRequest/4d70678c-81e4-4ff4-8c67-17596fd0aa46/", "lastModified": "2024-01-30T12:01:24Z", "outcome": { "resourceType": "OperationOutcome", "meta": { "lastUpdated": "2024-01-30T12:01:24Z" }, "issue": [ { "severity": "information", "code": "informational", "diagnostics": "No issues detected during validation." } ] } } } ]
Searchsets
These Bundles are returned in response to GET requests without an ID. entries within these bundles will depend on the endpoint queried and the search parameters included.
Each entry is expected to include a fullUrl identifying the URL that can be used to retrieve the resource on the server; the resource itself; and a search element detailing whether the resource was included in the search response due to it matching the query parameters, "mode": "match", or whether it was included via the _include parameter, "mode": "include".
"entry": [ { "fullUrl": "https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/44707473", "resource": { "resourceType": "Specimen", "id": "44707473", "meta": { "versionId": "1", "lastUpdated": "2024-05-13T14:28:05.843+00:00", "source": "#CJ6XJLTGD315XL2Z" }, "identifier": [ { "system": "https://fhir.add.nhs.uk/Id/specimenId", "value": "RGT03135" } ], "status": "unavailable", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "445295009", "display": "Blood specimen with EDTA" } ] }, "subject": { "reference": "Patient/44707475", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307946" } }, "request": [ { "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-Example" } ] }, "search": { "mode": "match" } } ]
StructureDefinition UKCore-Composition
There are two use cases for Compositions within Genomics.
For Order Management, Compositions will be limited to documents generated by the central broker for capturing snapshots of Test orders and results in order to maintain historical accuracy, as per the DocumentReference generate OperationDefinition. These will typically form the first entry of a Document Bundle and as such will not be exposed via their own endpoint, nor allow creates, reads or updates from client systems on the resource itself.
Usage of the Compostion resource and generation of documents is pending internal review
To support cross border data sharing Compositions MAY be aligned to the HL7 EU Lab Composition profile as a wrap around structured reports, though use of this profile in production is currently under review.
For the Unified Genomic Record, Compositions will form the header or 'contents page' of the UGR itself. section elements will be used to emulate the UGR folders. CodeSystems/codes for the required sections of the UGR are currently under development.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition | UKCore | trial-use |
| UKCoreComposition (Composition) | C | Composition | Element idCompositionShort description A set of resources composed into a single coherent clinical statement with clinical attestation DefinitionA set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition SHALL be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc. While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idComposition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idComposition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idComposition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idComposition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idComposition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idComposition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| careSettingType | C | 0..1 | Extension(CodeableConcept) | Element idComposition.extension:careSettingTypeShort description Used to support the type of care setting associated with a composition or a list. Alternate namesextensions, user content DefinitionThe type of care setting associated with a composition or a list. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idComposition.identifierShort description Version-independent identifier for the Composition DefinitionA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idComposition.statusShort description The workflow / clinical status of this composition. DefinitionThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. Need to be able to mark interim, amended, or withdrawn compositions or documents. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. The workflow/clinical status of the composition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | S Σ | 1..1 | CodeableConceptBinding | Element idComposition.typeShort description Specifies the particular kind of composition. DefinitionSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. Key metadata element describing the composition, used in searching/filtering. For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. SNOMED CT Document Type UKCoreDocumentType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 0..* | CodeableConceptBinding | Element idComposition.categoryShort description Categorization of Composition DefinitionA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. This is a metadata field from XDS/MHD. A ValueSet to identify the category of a composition. UKCoreCompositionCategory (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 0..1 | Reference(Resource) | Element idComposition.subjectShort description Who and / or what the composition is about. DefinitionWho or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. For clinical documents, this is usually the patient. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idComposition.encounterShort description Context of the Composition DefinitionDescribes the clinical encounter or type of care this documentation is associated with. Provides context for the composition and supports searching. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idComposition.dateShort description Composition editing time DefinitionThe composition editing time, when the composition was last logically changed by the author. dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging. The Last Modified Date on the composition may be after the date of the document was attested without being changed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author | S Σ C | 1..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idComposition.authorShort description Identifies who is responsible for the information in the composition. DefinitionIdentifies who is responsible for the information in the composition, not necessarily who typed it in. Identifies who is responsible for the content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| title | Σ | 1..1 | string | There are no (further) constraints on this element Element idComposition.titleShort description Human Readable name/title DefinitionOfficial human-readable label for the composition. For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| confidentiality | S Σ | 0..1 | codeBinding | Element idComposition.confidentialityShort description The code specifying the level of confidentiality of the Composition. DefinitionThe code specifying the level of confidentiality of the Composition. The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. Codes specifying the level of confidentiality of the composition. v3.ConfidentialityClassification (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| attester | 0..* | BackboneElement | There are no (further) constraints on this element Element idComposition.attesterShort description Attests to accuracy of composition DefinitionA participant who has attested to the accuracy of the composition/document. Identifies responsibility for the accuracy of the composition content. Only list each attester once. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idComposition.attester.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.attester.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.attester.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| mode | 1..1 | codeBinding | There are no (further) constraints on this element Element idComposition.attester.modeShort description personal | professional | legal | official DefinitionThe type of attestation the authenticator offers. Indicates the level of authority of the attestation. Note that FHIR strings SHALL NOT exceed 1MB in size The way in which a person authenticated a composition. CompositionAttestationMode (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| time | 0..1 | dateTime | There are no (further) constraints on this element Element idComposition.attester.timeShort description When the composition was attested DefinitionWhen the composition was attested by the party. Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| party | C | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idComposition.attester.partyShort description Who attested the composition DefinitionWho attested the composition in the specified way. Identifies who has taken on the responsibility for accuracy of the composition content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| custodian | S Σ C | 0..1 | Reference(Organization) | Element idComposition.custodianShort description Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. DefinitionIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. Identifies where to go to find the current version, where to report issues, etc. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relatesTo | 0..* | BackboneElement | There are no (further) constraints on this element Element idComposition.relatesToShort description Relationships to other compositions/documents DefinitionRelationships that this composition has with other compositions or documents that already exist. A document is a version specific composition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idComposition.relatesTo.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.relatesTo.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.relatesTo.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | 1..1 | codeBinding | There are no (further) constraints on this element Element idComposition.relatesTo.codeShort description replaces | transforms | signs | appends DefinitionThe type of relationship that this composition has with anther composition or document. If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. The type of relationship between documents. DocumentRelationshipType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| target[x] | 1..1 | There are no (further) constraints on this element Element idComposition.relatesTo.target[x]Short description Target of the relationship DefinitionThe target composition/document of this relationship. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| targetIdentifier | Identifier | There are no (further) constraints on this element Data type | ||||
| targetReference | Reference(Composition) | There are no (further) constraints on this element Data type | ||||
| event | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idComposition.eventShort description The clinical service(s) being documented DefinitionThe clinical service, such as a colonoscopy or an appendectomy, being documented. Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. The event needs to be consistent with the type element, though can provide further information if desired. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idComposition.event.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.event.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.event.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idComposition.event.codeShort description Code(s) that apply to the event being documented DefinitionThis list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. This list of codes represents the main clinical acts being documented. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idComposition.event.periodShort description The period covered by the documentation DefinitionThe period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| detail | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idComposition.event.detailShort description The event(s) being documented DefinitionThe description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| section | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idComposition.sectionShort description Composition is broken into sections DefinitionThe root of the sections that make up the composition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idComposition.section.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.section.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idComposition.section.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| title | 0..1 | string | There are no (further) constraints on this element Element idComposition.section.titleShort description Label for section (e.g. for ToC) Alternate namesheader, label, caption DefinitionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | 0..1 | CodeableConceptBinding | Element idComposition.section.codeShort description Classification of section (recommended) DefinitionA code identifying the kind of content contained within the section. This must be consistent with the section title. Provides computable standardized labels to topics within the document. The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. Classification of a section of a composition/document. UKCoreCompositionSectionCode (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | C | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idComposition.section.authorShort description Who and/or what authored the section DefinitionIdentifies who is responsible for the information in this section, not necessarily who typed it in. Identifies who is responsible for the content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | C | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idComposition.section.focusShort description Who/what the section is about, when it is not about the subject of composition DefinitionThe actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idComposition.section.textShort description Text summary of the section, for human interpretation DefinitionA human-readable narrative that contains the attested content of the section, 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety. The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 Constraints
| ||
| mode | 0..1 | codeBinding | There are no (further) constraints on this element Element idComposition.section.modeShort description working | snapshot | changes DefinitionHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. This element is labeled as a modifier because a change list must not be misunderstood as a complete list. The processing mode that applies to this section. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| orderedBy | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.section.orderedByShort description Order of section entries DefinitionSpecifies the order applied to the items in the section entries. Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. What order applies to the items in the entry. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| entry | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idComposition.section.entryShort description A reference to data that supports this section DefinitionA reference to the actual resource from which the narrative in the section is derived. If there are no entries in the list, an emptyReason SHOULD be provided. The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 Constraints
| ||
| emptyReason | C | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.section.emptyReasonShort description Why the section is empty DefinitionIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. Allows capturing things like "none exist" or "not asked" which can be important for most lists. The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. If a section is empty, why it is empty. The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 Constraints
| ||
| section | C | 0..* | see (section) | There are no (further) constraints on this element Element idComposition.section.sectionShort description Nested Section DefinitionA nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document. The cardinality or value of this element may be affected by these constraints: cmp-1 Mappings
|
| FHIR | MDS | HL7v2 |
|---|---|---|
Additional Guidance
- extension:basedOn-order-or-requisition
- extension:information-recipient
- extension:diagnosticReport-reference
- status
- type
- category
- subject
- date
- author
- title
- section
extension:basedOn-order-or-requisition
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: Composition Profile). A reference to the ServiceRequest which this report is in response to."extension": [ { "url": "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition", "valueReference": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderFormUpdated-TrioTesting-Example" } } ],
extension:information-recipient
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: Composition Profile). A reference to the recipient for a report, could potentially be used to reference additional recipients over the subject and original requester for the request."extension": [ { "url": "http://hl7.eu/fhir/StructureDefinition/information-recipient", "valueReference": { "reference": "PractitionerRole/PractitionerRole-EugeneSmith-Example" } } ],
extension:diagnosticReport-reference
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: Composition Profile). A reference to the focal DiagnosticReport this Composition is for."extension": [ { "url": "http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference", "valueReference": { "reference": "DiagnosticReport/DiagnosticReport-GenomicVariantAssessment-Example" } } ],
status
Fixed value of 'final'"status": "final",
type
SNOMED CT code for either a Laboratory Request (24691000000102) or Genetic report (1054161000000101)"type": { "coding": [ { "system": "http://snomed.info/sct", "code": "1054161000000101", "display": "Genetic report (record artifact)" } ] },
category
Fixed codes for conformance to the EU Lab Composition profile (for cross border sharing of lab reports)."category": [ { "coding": [ { "system": "http://loinc.org", "code": "26436-6", "display": "Laboratory studies (set)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "1236877003", "display": "Genetic pathology" } ] } ],
subject
Matches subject reference included in either the DiagnosticReport or ServiceRequest"subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } },
date
SHALL be the dateTime the Composition was generated by the central broker"date": "2022-07-11T09:00:00Z",
author
Fixed to an identifier for the central broker (TBC). The author for the underlying ServiceRequest or DiagnosticReport can be retrieved by interrogating the appropriate resources."author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/spine-ASID", "value": "200000000215" } } ],
title
SHALL match the SNOMED CT display used within Composition.type"title": "Genetic report (record artifact)",
section
To conform to EU Lab, SHOULD include references to the results that form part of the genomic report. For the UGR, will include sections that conform to the UGR folders, this work is currently in development."section": [ { "title": "Results", "code": { "coding": [ { "system": "http://loinc.org", "code": "26436-6", "display": "Laboratory studies (set)" } ] }, "entry": [ { "reference": "Observation/Observation-GenomicTherapeuticImplication-Example" }, { "reference": "Observation/Observation-GenomicsVariantSLC52A2-Example" } ] } ]
StructureDefinition UKCore-Condition
For detailing any Condition related information about the proband/consultands within a test order.
It is expected that the information used to populate this resource SHOULD be sourced from the requesters EHR system. As such, there is no limit on the amount of detail that can be provided, though at a minimum the code and subject fields SHOULD be populated.
It is also highly preferred if the verificationStatus, onsetDateTime, recordedDate, recorded and abatementDateTime are populated if applicable/known.
The primary condition, being tested for SHOULD be referenced via ServiceRequest.reasonReference, additional relevant conditions SHOULD be referenced via ServiceRequest.supportingInfo.
For Suspected Diagnoses, it is expected that the following fields will be populated differently from a confirmed diagnosis:
| Element | Value |
|---|---|
| clinicalStatus | Unpopulated |
| verificationStatus | Fixed to unconfirmed or one of its child codes |
| category | Do not use problem-list-item. Instead, presenting-complaint or encounter-diagnosis is expected |
| severity | Unpopulated |
| onset[x] | Unpopulated (details regarding observations/findings supporting the diagnosis, including dates, should be recorded under evidence |
| abatement[x] | Unpopulated |
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition | UKCore | trial-use |
| UKCoreCondition (Condition) | C | Condition | There are no (further) constraints on this element Element idConditionShort description Detailed information about conditions, problems or diagnoses DefinitionA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idCondition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCondition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCondition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCondition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idCondition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idCondition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodyStructureR6 | C | 0..1 | Extension(Reference(BodyStructure)) | Element idCondition.extension:bodyStructureR6Short description An extension to replicate the changes within R6 to support adding a reference to the body part affected by the diagnosed condition. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(BodyStructure)) Extension URLhttp://hl7.org/fhir/6.0/StructureDefinition/extension-Condition.bodyStructure ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| conditionEpisode | C | 0..* | Extension(CodeableConcept) | Element idCondition.extension:conditionEpisodeShort description The episodicity value of the condition can be represented by one of the following codes: \nfirst | new | review | end. Alternate namesextensions, user content DefinitionThe episodicity status of a condition. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCondition.identifierShort description External Ids for this condition DefinitionBusiness identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). 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. For example, multiple Patient and a Person resource instance might share the same social insurance number. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| clinicalStatus | S Σ ?! C | 0..1 | CodeableConceptBinding | Element idCondition.clinicalStatusShort description The clinical status of the condition. DefinitionThe clinical status of the condition. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The clinical status of the condition or diagnosis. ConditionClinicalStatusCodes (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, con-3, con-4, con-5 Constraints
| ||
| verificationStatus | S Σ ?! C | 0..1 | CodeableConceptBinding | Element idCondition.verificationStatusShort description The verification status to support the clinical status of the condition. DefinitionThe verification status to support the clinical status of the condition. verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status. The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The verification status to support or decline the clinical status of the condition or diagnosis. ConditionVerificationStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, con-3, con-5 Constraints
| ||
| category | 0..* | CodeableConceptBinding | Element idCondition.categoryShort description problem-list-item | encounter-diagnosis DefinitionA category assigned to the condition. The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. A ValueSet to identify the category of a condition. UKCoreConditionCategory (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| severity | S | 0..1 | CodeableConceptBinding | Element idCondition.severityShort description A subjective assessment of the severity of the condition as evaluated by the clinician. DefinitionA subjective assessment of the severity of the condition as evaluated by the clinician. Coding of the severity with a terminology is preferred, where possible. A subjective assessment of the severity of the condition as evaluated by the clinician. Condition/DiagnosisSeverity (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 0..1 | CodeableConceptBinding | Element idCondition.codeShort description Identification of the condition, problem or diagnosis. Alternate namestype DefinitionIdentification of the condition, problem or diagnosis. 0..1 to account for primarily narrative only resources. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A code from the SNOMED Clinical Terminology UK with the expression (<404684003 |Clinical finding| OR <413350009 |Finding with explicit context| OR <272379006 |Event|). UKCoreConditionCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idCondition.bodySiteShort description Anatomical location, if relevant DefinitionThe anatomical location where this condition manifests itself. Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 1..1 | Reference(Group | Patient) | Element idCondition.subjectShort description Indicates the patient or group who the condition record is associated with. Alternate namespatient DefinitionIndicates the patient or group who the condition record is associated with. Group is typically used for veterinary or public health use cases. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idCondition.encounterShort description Encounter created as part of DefinitionThe Encounter during which this Condition was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| onset[x] | Σ | 0..1 | There are no (further) constraints on this element Element idCondition.onset[x]Short description Estimated or actual date, date-time, or age DefinitionEstimated or actual date or date-time the condition began, in the opinion of the clinician. Age is generally used when the patient reports an age at which the Condition began to occur. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| onsetAge | Age | There are no (further) constraints on this element Data type | ||||
| onsetDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| onsetPeriod | Period | There are no (further) constraints on this element Data type | ||||
| onsetRange | Range | There are no (further) constraints on this element Data type | ||||
| onsetString | string | There are no (further) constraints on this element Data type | ||||
| abatement[x] | C | 0..1 | There are no (further) constraints on this element Element idCondition.abatement[x]Short description When in resolution/remission DefinitionThe date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate. There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated. The cardinality or value of this element may be affected by these constraints: ele-1, con-4 Constraints
| |||
| abatementAge | Age | There are no (further) constraints on this element Data type | ||||
| abatementDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| abatementPeriod | Period | There are no (further) constraints on this element Data type | ||||
| abatementRange | Range | There are no (further) constraints on this element Data type | ||||
| abatementString | string | There are no (further) constraints on this element Data type | ||||
| recordedDate | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idCondition.recordedDateShort description Date record was first recorded DefinitionThe recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| recorder | S Σ C | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idCondition.recorderShort description Individual who recorded the record and takes responsibility for its content. DefinitionIndividual who recorded the record and takes responsibility for its content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| asserter | Σ C | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idCondition.asserterShort description Person who asserts this condition DefinitionIndividual who is making the condition statement. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| stage | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idCondition.stageShort description Stage/grade, usually assessed formally DefinitionClinical stage or grade of a condition. May include formal severity assessments. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idCondition.stage.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.stage.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.stage.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| summary | C | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCondition.stage.summaryShort description Simple summary (disease specific) DefinitionA simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing condition stages (e.g. Cancer stages). The cardinality or value of this element may be affected by these constraints: ele-1, con-1 Constraints
| ||
| assessment | C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | There are no (further) constraints on this element Element idCondition.stage.assessmentShort description Formal record of assessment DefinitionReference to a formal record of the evidence on which the staging assessment is based. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ClinicalImpression | DiagnosticReport | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, con-1 Constraints
| ||
| type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCondition.stage.typeShort description Kind of staging DefinitionThe kind of staging, such as pathological or clinical staging. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the kind of condition staging (e.g. clinical or pathological). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| evidence | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idCondition.evidenceShort description Supporting evidence DefinitionSupporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idCondition.evidence.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.evidence.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.evidence.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ C | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCondition.evidence.codeShort description Manifestation/symptom DefinitionA manifestation or symptom that led to the recording of this condition. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes that describe the manifestation or symptoms of a condition. ManifestationAndSymptomCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, con-2 Constraints
| ||
| detail | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCondition.evidence.detailShort description Supporting information found elsewhere DefinitionLinks to other relevant information, including pathology reports. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1, con-2 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idCondition.noteShort description Additional information about the Condition DefinitionAdditional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Condition | Patient Clinical Presentation, Diabetic complications | DG1 |
| Condition.bodySite | Has multiple primary tumours, Count of tumours, Site of tumour (many), Abnormal infection history site, Abnormal infection history site organism | Multiple DG1 segments (bodySite for condition not in scope for HL7v2) |
| Condition.verificationStatus | Known/suspected disease | DG1-6 |
| Condition.recordedDate | Date of diagnosis, Diagnosis during pregnancy | DG1-5 |
| Condition.clinicalStatus | Disease status, Is patient in treatment free remission, Is diabetes in remission | Potentially mapped to DG1-17 |
| Condition.code | Phenotypic details (Many), Solid tumour type, Liquid tumour type, Laterality of hearing loss, Fetal maternal screening genotype, Fetal paternal screening genotype, Thyroid gland state, Pituitary tumour type, Pancreatic tumour type, Phaeochromocytoma, Progeroid features, Severity of hearing loss, Retinal degeneration, Hepatic vs neurological presentation, Suspected inborn error type(s), Primary Sample - Solid tumour type | Additional DG1 segments (DG1-3) |
| Condition.onsetDateTime | Date of disease onset, Duration of hyperinsulism (when compared to abatementDateTime | for non OML messages PRB-16 |
| Condition.evidence.detail( reference( FamilyMemberHistory, Media ) ) | Pedigree details/diagram, Disease penetrance | N/A not in scope for HL7v2, could be added as additional DG1 segments related to relatives (representation of family history in HL7v2 still pending investigation) |
| Condition.evidence.code | Symptoms at onset | Separate DG1 with DG1-17=S |
Additional Guidance
extension:bodyStructureR6
Extension provided to allow users to ascribe topology and morphology items to conditions themselves. For collection of body structure information for primary and secondary tumours separately, these should be referenced from conditions associated with the primary and secondary tumour respectively."extension": [ { "url": "http://hl7.org/fhir/6.0/StructureDefinition/extension-Condition.bodyStructure", "valueReference": { "reference": "BodyStructure/BodyStructure-BodySiteLocationLungs-Example" } } ]
code
SHOULD be present. SNOMED CT coding is preferred, though alternative codings MAY be provided where the code is not present in SNOMED CT, e.g. more specific test directory Clinical Indication codes MAY be used."code": { "coding": [ { "system": "http://snomed.info/sct", "code": "95820000", "display": "Bilateral hearing loss" } ] },
subject
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
note
For recording additional information regarding the condition where this does not fit into the structured fields or cannot be structured due to the way this information has been recorded in source systems."note": [ { "text": "hearing loss since childhood (example)" } ]
StructureDefinition Consent
Only expected to be used for wrapping Record of Discussion resources within the WGS pathway. Consent for testing is implied through submission of a test to the Genomic Order Management service. Consent for Data Access as part of the UGR SHOULD follow guidance provided within Consent guidance page and the IHE PCF Framework.
Only a minimal amount of mandatory information needs to be populated for Order Management recording of RoDs.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Consent | HL7 International | trial-use |
| Consent | C | DomainResource | Element idConsentShort description A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time DefinitionA record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idConsent.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idConsent.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idConsent.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idConsent.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idConsent.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idConsent.identifierShort description Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General {
"system": "urn:ietf:rfc:3986",
"value": "Local eCMS identifier"
}Mappings
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idConsent.statusShort description draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid. Indicates the state of the consent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| scope | Σ ?! | 1..1 | CodeableConceptBinding | Element idConsent.scopeShort description Which of the four areas this resource covers (extensible) DefinitionA selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 1..* | CodeableConceptBinding | Element idConsent.categoryShort description Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| patient | Σ C | 0..1 | Reference(Patient) | Element idConsent.patientShort description Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| dateTime | Σ | 0..1 | dateTime | Element idConsent.dateTimeShort description When this Consent was created or indexed DefinitionWhen this Consent was issued / created / indexed. This is not the time of the original consent, but the time that this statement was made or derived. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..* | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idConsent.performerShort description Who is agreeing to the policy and rules Alternate namesconsentor DefinitionEither the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| organization | Σ C | 0..* | Reference(Organization) | Element idConsent.organizationShort description Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| source[x] | Σ | 0..1 | Element idConsent.source[x]Short description Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| sourceAttachment | Attachment | Data type | ||||
| sourceReference | Reference(Consent | Contract | DocumentReference | QuestionnaireResponse) | Data type Reference(Consent | Contract | DocumentReference | QuestionnaireResponse) | ||||
| policy | 0..* | BackboneElement | Element idConsent.policyShort description Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idConsent.policy.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| authority | C | 0..1 | uri | Element idConsent.policy.authorityShort description Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1, ppc-1 Constraints
| ||
| uri | C | 0..1 | uri | Element idConsent.policy.uriShort description Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. This element is for discoverability / documentation and does not modify or qualify the policy rules. The cardinality or value of this element may be affected by these constraints: ele-1, ppc-1 Constraints
| ||
| policyRule | Σ C | 0..1 | CodeableConceptBinding | Element idConsent.policyRuleShort description Regulation that this consents to DefinitionA reference to the specific base computable regulation or policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource. Regulatory policy examples. ConsentPolicyRuleCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, ppc-1 Constraints
| ||
| verification | Σ | 0..* | BackboneElement | Element idConsent.verificationShort description Consent Verified by patient or family DefinitionWhether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idConsent.verification.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.verification.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.verification.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| verified | Σ | 1..1 | boolean | Element idConsent.verification.verifiedShort description Has been verified DefinitionHas the instruction been verified. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| verifiedWith | C | 0..1 | Reference(Patient | RelatedPerson) | Element idConsent.verification.verifiedWithShort description Person who verified DefinitionWho verified the instruction (Patient, Relative or other Authorized Person). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| verificationDate | 0..1 | dateTime | Element idConsent.verification.verificationDateShort description When consent verified DefinitionDate verification was collected. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| provision | Σ | 0..1 | BackboneElement | Element idConsent.provisionShort description Constraints to the base Consent.policyRule DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idConsent.provision.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.provision.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.provision.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | codeBinding | Element idConsent.provision.typeShort description deny | permit DefinitionAction to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. Note that FHIR strings SHALL NOT exceed 1MB in size How a rule statement is applied, such as adding additional consent or removing consent. ConsentProvisionType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | Element idConsent.provision.periodShort description Timeframe for this rule DefinitionThe timeframe in this rule is valid. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actor | 0..* | BackboneElement | Element idConsent.provision.actorShort description Who|what controlled by this rule (or group, by role) DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the exception The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idConsent.provision.actor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.provision.actor.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.provision.actor.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| role | 1..1 | CodeableConceptBinding | Element idConsent.provision.actor.roleShort description How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reference | C | 1..1 | Reference(CareTeam | Device | Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idConsent.provision.actor.referenceShort description Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareTeam | Device | Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| action | Σ | 0..* | CodeableConcept | Element idConsent.provision.actionShort description Actions controlled by this rule DefinitionActions controlled by this Rule. Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. all actions Detailed codes for the consent action. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| securityLabel | Σ | 0..* | CodingBinding | Element idConsent.provision.securityLabelShort description Security Labels that define affected resources DefinitionA security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | Σ | 0..* | CodingBinding | Element idConsent.provision.purposeShort description Context of activities covered by this rule DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. When the purpose of use tag is on the data, access request purpose of use shall not conflict. What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| class | Σ | 0..* | CodingBinding | Element idConsent.provision.classShort description e.g. Resource Type, Profile, CDA, etc. DefinitionThe class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. The class (type) of information a consent rule covers. ConsentContentClass (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..* | CodeableConcept | Element idConsent.provision.codeShort description e.g. LOINC or SNOMED CT code, etc. in the content DefinitionIf this code is found in an instance, then the rule applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| dataPeriod | Σ C | 0..1 | Period | Element idConsent.provision.dataPeriodShort description Timeframe for data controlled by this rule DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this rule. This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| data | Σ | 0..* | BackboneElement | Element idConsent.provision.dataShort description Data controlled by this rule DefinitionThe resources controlled by this rule if specific resources are referenced. all data The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idConsent.provision.data.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.provision.data.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.provision.data.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meaning | Σ | 1..1 | codeBinding | Element idConsent.provision.data.meaningShort description instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings SHALL NOT exceed 1MB in size How a resource reference is interpreted when testing consent restrictions. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 1..1 | Reference(Resource) | Element idConsent.provision.data.referenceShort description The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| provision | 0..* | see (provision) | There are no (further) constraints on this element Element idConsent.provision.provisionShort description Nested Exception Rules DefinitionRules which provide exceptions to the base rule or subrules. |
- Consent-RoD-PheobeSmitham-Example
- Consent-RoD-PheobeSmithamFather-Example
- Consent-RoD-PheobeSmithamMother-Example
- Consent-RoD-PheobeSmithamYoungPersonAssentForm-Example
- Consent-RoDYoungPersonAssentFormAvailable-Example
- Consent-RoDAvailable-Example
- Consent-RoDToFollow-Example
- Consent-RoD-PheobeSmithamAttachmentURL-Example
- Consent-RoD-PheobeSmithamAttachmentData-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| Consent.sourceAttachment | RoD - Record of discussion form - copy attached | CON-19 (for OML, included in RoD, referenced from NTE-3) |
| Consent.status | RoD - Patient conversation taken place, ROD form to follow | Inferred through CON-19 value (for OML, included in RoD, referenced from NTE-3) |
Additional Guidance
status
SHALL be present. Fixed code of 'proposed' where consent discussion has taken place but RoD form has not been provided alongside test order. 'draft' if discussion has not yet taken place and 'active' for completed RoD, regardless of whether the patient has consented to information sharing (responses to specific consent statements SHOULD be recorded in the RoD itself)."status": "proposed",
scope
For WGS RoD this SHALL be fixed to the below code:"scope": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentscope", "code": "research", "display": "Research" } ] },
category
For WGS RoD this SHALL be fixed to the below code:"category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/consentcategorycodes", "code": "research", "display": "Research Information Access" } ] } ],
patient
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS."subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
source[x]
SHALL be present for RoD entities. The Source element MAY either be a pointer to the location of the PDF version of the RoD, either hosted by the source/client system, accessed via NRL or embedded within the message payload, base64 encoded (using sourceAttachment), or a reference to a QuestionnaireResponse resource (using sourceReference), if this has been collected in a structured format, using the Questionnaire-Genomic Testing RoD template."sourceReference": { "reference": "QuestionnaireResponse/QuestionnaireResponse-RoD-Example" },
policy
For WGS RoD this SHALL be fixed to the below uris:"policy": [ { "authority": "https://www.england.nhs.uk", "uri": "https://www.england.nhs.uk/publication/nhs-genomic-medicine-service-record-of-discussion-form" } ]
provision
Used to reference the ServiceRequest the Consent applies to. SHALL be present where the consent only applies to a specific test."provision": { "data": [ { "meaning": "instance", "reference": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-Example" } } ] }
StructureDefinition UKCore-DiagnosticReport
The requirements of a specific Genomics DiagnosticReport is currently under review.
The draft profile is provided below for completeness.
Currently, only requirements for initial Pathology reports, provided with a test order, have been reviewed. DiagnosticReports containing the results of genomic testing are expected to be attached/provided as PDF documents during the alpha phase of the GMS development programme.
It is expected structured DiagnosticReports will mimic the structure proposed within the HL7 International Genomic Reporting IG, though customizations for use within the UK still need to be investigated.
Additionally, to support sharing across borders, lab reports MAY additionally be aligned to the HL7 EU Lab Implementation guide, though requirement on suppliers to conform to this structure are still under review. details of elements of interest for alignment with the EU DiagnosticReport profile are provided below.
Genomic DiagnosticReports which have been updated post submission SHALL be accompanied by Provenance resources, referencing the DiagnosticReport which detail when the resource was changed, who made the change and why.
Whilst unstructured Diagnostic Reports can also be represented by DocumentReference resources, the DiagnosticReport resource is preferred for any documents constituting actual reports, as the resource allows capture of metadata not present in DocumentReference, such as the resultsInterpreter, specimen or conclusion, which would help in searching or for analytics. Use of DocumentReference resources is limited to other data files or documents.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport | UKCore | trial-use |
| UKCoreDiagnosticReport (DiagnosticReport) | C | DiagnosticReport | Element idDiagnosticReportShort description A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Alternate namesReport, Test, Result, Results, Labs, Laboratory DefinitionThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDiagnosticReport.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDiagnosticReport.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDiagnosticReport.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idDiagnosticReport.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idDiagnosticReport.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| compositionReferenceR5 | C | 0..1 | Extension(Reference(Composition)) | Element idDiagnosticReport.extension:compositionReferenceR5Short description A Composition reference for a DiagnosticReport. This is a R5 backport. Alternate namesextensions, user content DefinitionA Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. 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. Extension(Reference(Composition)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:compositionReferenceR5.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:compositionReferenceR5.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:compositionReferenceR5.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.compositionMappings
| |||
| value[x] | 1..1 | Element idDiagnosticReport.extension:compositionReferenceR5.value[x]Short description Reference to a Composition resource. DefinitionReference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueReference | Reference(Composition) | There are no (further) constraints on this element Data type | ||||
| noteR5 | C | 0..* | Extension(Annotation) | Element idDiagnosticReport.extension:noteR5Short description Comments about the diagnostic report. This is a R5 backport. Alternate namesextensions, user content DefinitionMay include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:noteR5.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:noteR5.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:noteR5.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.noteMappings
| |||
| value[x] | 1..1 | Element idDiagnosticReport.extension:noteR5.value[x]Short description Comments about the diagnostic report. DefinitionMay include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||||
| supportingInfoR5 | C | 0..* | Extension(Complex) | Element idDiagnosticReport.extension:supportingInfoR5Short description Additional info supporting the diagnostic report. This is a R5 backport. Alternate namesextensions, user content DefinitionThis backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 2..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | C | 1..1 | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:typeShort description Supporting information role code. Alternate namesextensions, user content DefinitionThe code value for the role of the supporting information in the diagnostic report. 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. Hl7VSVSObservationType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. typeMappings
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| reference | C | 1..1 | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:referenceShort description Who or what participated in the activities related to the family member history. Alternate namesextensions, user content DefinitionThe reference for the supporting information in the diagnostic report. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. referenceMappings
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueReference | Reference(DiagnosticReport | Observation | Procedure) | There are no (further) constraints on this element Data type | ||||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfoMappings
| |||
| value[x] | 0..0 | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idDiagnosticReport.identifierShort description Business identifier for report Alternate namesReportID, Filler ID, Placer ID DefinitionIdentifiers assigned to this report by the performer or other systems. Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. Usually assigned by the Information System of the diagnostic service provider (filler id). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | C | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element idDiagnosticReport.basedOnShort description What was requested Alternate namesRequest DefinitionDetails concerning a service requested. This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idDiagnosticReport.statusShort description The status of the diagnostic report. DefinitionThe status of the diagnostic report. Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. Note that FHIR strings SHALL NOT exceed 1MB in size The status of the diagnostic report. DiagnosticReportStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | S Σ | 0..* | CodeableConcept | Element idDiagnosticReport.categoryShort description A code that classifies the clinical discipline, department or diagnostic service that created the report. Alternate namesDepartment, Sub-department, Service, Discipline DefinitionA code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. Codes for diagnostic service sections. DiagnosticServiceSectionCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 1..1 | CodeableConceptBinding | Element idDiagnosticReport.codeShort description A code or name that describes this diagnostic report. Alternate namesType DefinitionA code or name that describes this diagnostic report. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes that describe Diagnostic Reports. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 0..1 | Reference(Device | Group | Location | Patient) | Element idDiagnosticReport.subjectShort description The subject of the report - usually, but not always, the patient. Alternate namesPatient DefinitionThe subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. SHALL know the subject context. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | Location | Patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | S Σ C | 0..1 | Reference(Encounter) | Element idDiagnosticReport.encounterShort description Health care event when test ordered. Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. Links the request to the Encounter context. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| effective[x] | Σ | 0..1 | There are no (further) constraints on this element Element idDiagnosticReport.effective[x]Short description Clinically relevant time/time-period for report Alternate namesObservation time, Effective Time, Occurrence DefinitionThe time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. Need to know where in the patient history to file/present this report. If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectiveDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| effectivePeriod | Period | There are no (further) constraints on this element Data type | ||||
| issued | S Σ | 0..1 | instant | Element idDiagnosticReport.issuedShort description Clinically relevant time / time-period for report. Alternate namesDate published, Date Issued, Date Verified DefinitionThe date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. Clinicians need to be able to check the date that the report was released. May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..* | Reference(CareTeam | Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idDiagnosticReport.performerShort description Responsible Diagnostic Service Alternate namesLaboratory, Service, Practitioner, Department, Company, Authorized by, Director DefinitionThe diagnostic service that is responsible for issuing the report. Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. Reference(CareTeam | Organization | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.performer.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| deviceReference | C | 0..1 | Extension(Reference(Device)) | Element idDiagnosticReport.performer.extension:deviceReferenceShort description A reference to a Device which interprets / performs the results of the DiagnosticReport. Alternate namesextensions, user content DefinitionAn additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idDiagnosticReport.performer.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idDiagnosticReport.performer.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| resultsInterpreter | Σ C | 0..* | Reference(CareTeam | Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreterShort description Primary result interpreter Alternate namesAnalyzed by, Reported by DefinitionThe practitioner or organization that is responsible for the report's conclusions and interpretations. Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. Might not be the same entity that takes responsibility for the clinical report. Reference(CareTeam | Organization | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| deviceReference | C | 0..* | Extension(Reference(Device)) | Element idDiagnosticReport.resultsInterpreter.extension:deviceReferenceShort description A reference to a Device which interprets / performs the results of the DiagnosticReport. Alternate namesextensions, user content DefinitionAn additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimen | C | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idDiagnosticReport.specimenShort description Specimens this report is based on DefinitionDetails about the specimens on which this diagnostic report is based. Need to be able to report information about the collected specimens on which the report is based. If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| result | S C | 0..* | Reference(Observation) | Element idDiagnosticReport.resultShort description Observations that are part of this diagnostic report. Alternate namesData, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer DefinitionObservations that are part of this diagnostic report. Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. Observations can contain observations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| imagingStudy | C | 0..* | Reference(ImagingStudy) | There are no (further) constraints on this element Element idDiagnosticReport.imagingStudyShort description Reference to full details of imaging associated with the diagnostic report DefinitionOne or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| media | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idDiagnosticReport.mediaShort description Key images associated with this report Alternate namesDICOM, Slides, Scans DefinitionA list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). Many diagnostic services include images in the report as part of their service. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.media.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.media.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| linkR5 | C | 0..* | Extension(Reference(DocumentReference)) | Element idDiagnosticReport.media.extension:linkR5Short description Reference to the image or data source Alternate namesextensions, user content DefinitionReference to the image or data source. To use this element the R4 version of DiagnosticReport.media.link SHALL have the value as extension http://hl7.org/fhir/StructureDefinition/data-absent-reason and valueCode as "unsupported". See https://build.fhir.org/versions.html#extensions-examples-complex for more details Extension(Reference(DocumentReference)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.media.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| comment | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.media.commentShort description Comment about the image (e.g. explanation) DefinitionA comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. The provider of the report should make a comment about each image included in the report. The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| link | Σ C | 1..1 | Reference(Media) | There are no (further) constraints on this element Element idDiagnosticReport.media.linkShort description Reference to the image source DefinitionReference to the image source. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| conclusion | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.conclusionShort description Clinical conclusion (interpretation) of test results Alternate namesReport DefinitionConcise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. Need to be able to provide a conclusion that is not lost among the basic result data. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| conclusionCode | 0..* | CodeableConceptBinding | Element idDiagnosticReport.conclusionCodeShort description Codes for the clinical conclusion of test results DefinitionOne or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Diagnosis codes provided as adjuncts to the report. SNOMEDCTClinicalFindings (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| presentedForm | C | 0..* | Attachment | There are no (further) constraints on this element Element idDiagnosticReport.presentedFormShort description Entire report as issued DefinitionRich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. "application/pdf" is recommended as the most reliable and interoperable in this context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
- DiagnosticReport-AnitaLamberts-Example
- DiagnosticReport-FayMutlowGeneticReport-Example
- DiagnosticReport-JamesMetcalfeGeneticReport-Example
- DiagnosticReport-PhoebeSmithGeneticReport-Example
- DiagnosticReport-MichaelJonesReport
- DiagnosticReport-MichaelJonesReport-Minimal
- DiagnosticReport-GenomicVariantAssessment-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| DiagnosticReport | Previous Genomic Report, Previous Diagnostic Report | OBX |
| DiagnosticReport.effectiveDateTime | PLCM activity - Date and time dataset created, PLCM activity - Turnaround time (calendar days), Previous genomic report - Test performed date, Previous non genomic report - Test performed date | Derived from OBR-7 in the ORU response message for the activity based on the OML request, OBX-19 |
| DiagnosticReport.identifier | PLCM activity - Local report identifier, Previous genomic report - Report identifier, Previous non genomic report - Report identifier | OBR-3 for report |
| DiagnosticReport.result | PLCM activity - Test outcome code (Many), Previous non genomic report - Test result value comparator, Previous non genomic report - Test result value unit of measure, Previous non genomic report - Test result reference range low, Previous non genomic report - Test result reference range high, Previous non genomic report - Test result test method, Previous non genomic report - Test result reference range text, Previous non genomic report - Test result clinical summary | OBX-3 elements for resulting report, OBX-5, OBX-6, OBX-7 (before operator), OBX-7 (after operator), OBX-17, OBX-7, OBX-8 |
| DiagnosticReport.conclusion | Previous genomic report - Report referral summary, Previous non genomic report - Report referral summary | OBX-5 |
| DiagnosticReport.presentedForm | Previous genomic report - Report file/link, Previous non genomic report - Report file/link | OBX-5 where OBX-2=ED or RP |
| DiagnosticReport.subject | Previous genomic report - Patient's first name, Previous genomic report - Patient's surname, Previous genomic report - Patient's address, Previous genomic report - Patient's post code, Previous genomic report - Patient's country, Previous genomic report - Patient's date of birth, Previous genomic report - Patient's NHS number, Previous genomic report - Patient's alternative identifier, Previous genomic report - Patient's relationship to requesting patient, Previous genomic report - Patient's clinical genetics number, Previous genomic report - Patient's pedigree number | PID attached to Patient Prior |
| DiagnosticReport.basedOn | Previous genomic report - Report lab test number, Previous genomic report - Original requester full name, Previous genomic report - Original requester organisation ODS code, Previous genomic report - Original requester reason for request, Previous non genomic report - Original requester full name, Previous non genomic report - Original requester organisation ODS code, Previous non genomic report - Original requester reason for request | ORC-2, ORC-12, ORC-21.10, ORC-16 |
| DiagnosticReport.conclusionCode | Previous genomic report - Report of genetic analysis, Previous non genomic report - Report result | OBR-5 |
| DiagnosticReport.performer | Previous genomic report - Report performer full name, Previous genomic report - Report performer organisation ODS code, Previous non genomic report - Report performer full name, Previous non genomic report - Report performer organisation ODS code | OBX-16, OBX-23.10 |
| DiagnosticReport.code | Previous non genomic report - Test type | OBR-4 |
Additional Guidance
- extension:mediaR5
- extension:recommended-action
- extension:genomic-study
- extension:supporting-info
- extension:workflow-relatedArtifact
- extension:DiagnosticReportCompositionR5
- basedOn
- status
- category
- code
- subject
- performer
- resultsInterpreter
- specimen
- conclusionCode
- presentedForm
- result
extension:mediaR5
TBC. Only relevant for structured genomic reports. Reference to DocumentReference resources pointing to the Genomic Data Files used as the basis for the report. Usage of this field over extension:supporting-info is pending further investigation."extension" : [ { "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link", "extension" : [ { "url" : "link", "valueReference": { "reference" : "DocumentReference/DocumentReference-PharmCAT-Example" } } ] } } ],
extension:recommended-action
TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to Task resource indicating recommended action to take in response to the report's result/conclusion."extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/recommended-action", "valueReference" : { "reference" : "Task/MedicationRecommendationExample1" } } ],
extension:genomic-study
TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to Procedure resources indicating the analyses performed as part the genomic test order."extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-reference", "valueReference" : { 🔗 "reference" : "Procedure/PGXGenomicStudy" } } ]
extension:supporting-info
TBC. Only relevant for structured genomic reports (included in the Genomic Report Profile in the Genomics Report IG). Reference to the genomic data files analysed as part of the test order, forming the report. Reference to DocumentReference resource which links to the binary data file."extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo", "valueReference" : { "reference" : "DocumentReference/DocumentReference-PharmCAT-Example" } } ],
extension:workflow-relatedArtifact
TBC. Only relevant for structured genomic reports (included in Genomic Report Profile in the Genomics Report IG). A reference to the guidelines or other knowledge artifacts which were used to guide interpretation or recommended actions included within this DiagnosticReport.If entries constitute published papers, they SHOULD be referenced using a known citation style, e.g. Vancouver/Harvard. Alternatively for online texts, these MAY be referenced via URL only.
A fixed value of 'citation' is expected for the type element, though this recommendation is pending further use cases.
"extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact", "valueRelatedArtifact" : { "type" : "citation", "url" : "https://cpicpgx.org/guidelines/guideline-for-clopidogrel-and-cyp2c19)" } } ],
extension:DiagnosticReportCompositionR5
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: DiagnosticReport Profile). A reference to the Composition which wraps this report for data sharing."extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition", "valueReference": { "reference": "Composition/Composition-EULabGenomicReport-Example" } } ],
basedOn
SHOULD reference the originating ServiceRequest if this is an instance of a genomic diagnostic report resulting from a GMS test order."basedOn": [ { "reference": "ServiceRequest-SavedTestOrder-Example" } ],
status
SHALL use base HL7 codes for DiagnosticReport.status. A DiagnosticReport SHOULD only be marked as final if the report is complete and verified by an authorised person.Codes for DiagnosticReport status and usage within Genomics are provided below:
| Lvl | Code | Definition | Usage within Genomics |
|---|---|---|---|
| 1 | registered | The existence of the report is registered, but there is nothing yet available. | Not expected to be used within Genomics |
| 1 | partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. | MAY be used for interim reports, SHALL NOT be used for reports intended to be acted upon by clinicians |
| 2 | preliminary | Verified early results are available, but not all results are final. | MAY be used within Genomics |
| 1 | final | The report is complete and verified by an authorized person. | SHALL be used for final reports |
| 1 | amended | Subsequent to being final, the report has been modified. This includes any change in the results, diagnosis, narrative text, or other content of a report that has been issued. | SHOULD be used for resports ammended after submission of a final report |
| 2 | corrected | Subsequent to being final, the report has been modified to correct an error in the report or referenced results. | MAY be used in place of ammended for a correction to a finalised report |
| 2 | appended | Subsequent to being final, the report has been modified by adding new content. The existing content is unchanged. | Not expected to be used within Genomics but MAY be used where applicable, pending use case identification |
| 1 | cancelled | The report is unavailable because the measurement was not started or not completed (also sometimes called "aborted"). | MAY be used where a lab submits a cancellation/failure report, pending use case identification and testing |
| 1 | entered-in-error | The report has been withdrawn following a previous final release. This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".). | Not expected to be used within Genomics |
| 1 | unknown | The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. | SHALL NOT be used within Genomics |
"status": "final",
category
Potentially multiple categories to specify the specialty the report is relevant for. Different codings are expected by the Genomic Report and EU Lab profiles."category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0074", "code": "GE" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "1236877003", "display": "Genetic pathology" } ] } ],
code
SHOULD use a record artifact concept from SNOMED CT where an appropriate code exists, else text is preferred to indicate the document type."code": { "coding": [ { "system": "http://snomed.info/sct", "code": "4321000179101", "display": "Hematology report (record artifact)" } ] },
subject
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
performer
SHOULD reference the organization responsible for the testing, preferably by ODS code."performer": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "REP" } } ],
resultInterpreter
SHOULD reference the person responsible for interpreting the raw results, preferably by a recognised NHS identifier, such as SDS code."resultsInterpreter": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "999999999999" } } ],
specimen
SHOULD reference the specimen used during testing to generate the report, if the document is a Genomic report."specimen": [ { "reference": "Specimen/Specimen-BloodEDTA-Example" } ],
conclusionCode
If possible, unstructured reports wrapped within DiagnosticReports, SHOULD contain a conclusionCode element indicating the coded finding from the report, to aid analytics."conclusionCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "738542003", "display": "Dihydropyrimidine dehydrogenase poor metabolizer (finding)" } ] } ],
presentedForm
Genomic reports SHALL include a presentedForm element either referencing the location of the PDF report (located and accessible on either the source/client system or via NRL using appropriate authentication) or include the PDF report as a base64 encoded attachment within the message payload.Note: this guidance may change in the future as work on Structured Reporting matures
"presentedForm": [ { "url": "https://example.com/GenomicReports/ExampleReport.pdf" } ]
result
Raw results included within the report, to aid interpretation. These SHOULD take the form of Observation references, if providing a structured report."result" : [ { "reference" : "Observation/TherapeuticImplicationExample1", "display" : "impact for high risk allele" }, { "reference" : "Observation/GenotypeExample1" }, { "reference" : "Observation/OverallInterpExample1" } ]
StructureDefinition DocumentReference
The DocumentReference resource is used to reference data files generated as part of genomic testing and allow these files to be retrieved through the DRS API standard.
Primarily, the ServiceRequest SHALL be referenced via DiagnosticReport.basedOn. The DocumentReference then links back to the report via DocumentReference.context.related.
If following the Genomic Reporting IG, you could also reference the DocumentReference from the DiagnosticReport using the following chain:
DiagnosticReport.extension:genomic-study -> Procedure (Genomic Study).extension:genomic-study-analysis -> Procedure (Genomic Study Analysis).extension:output.extension:file.valueReference -> DocumentReference (Genomic Data File)
This requires use of the Genomic Study and Genomic Study Analysis profiles which have not yet been assessed for suitability in the UK. As such, this reference chain is only provided for reference.
The NHS England Genomics unit is also investigating backporting the R5 DiagnosticReport.media.link reference to DocumentReference to support referencing the data files from the DiagnosticReport directly. Until investigation is complete, DiagnosticReport resources MAY reference the DocumentReference for the data used by the report though the DiagnosticReport.extension:supporting-info element. In all cases the DocumentReference SHOULD reference the DNA Specimen from which the data originated and the ServiceRequest which triggered the capture of the data.
Additionally MAY be used within requests to reference binary files such as images or unstructured reports.
The Genomics-DocumentReference is currently based on the HL7 international version of the resource as the UKCore-DocumentReference profile is still in a draft status (and is pending use cases from the Unified Genomic Record project). Once this profile becomes active in UKCore its suitability for use and need for profiling within Genomics will be assessed.
The base DocumentReference resource is provided below for completeness.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/DocumentReference | HL7 International | trial-use |
| DocumentReference | C | DomainResource | Element idDocumentReferenceShort description A reference to a document DefinitionA reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. Usually, this is used for documents other than those defined by FHIR.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDocumentReference.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDocumentReference.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDocumentReference.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idDocumentReference.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idDocumentReference.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| masterIdentifier | Σ | 0..1 | Identifier | Element idDocumentReference.masterIdentifierShort description Master Version Specific Identifier DefinitionDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). CDA Document Id extension and root. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idDocumentReference.identifierShort description Other identifiers for the document DefinitionOther identifiers associated with the document, including version independent identifiers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idDocumentReference.statusShort description current | superseded | entered-in-error DefinitionThe status of this document reference. This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. The status of the document reference. DocumentReferenceStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| docStatus | Σ | 0..1 | codeBinding | Element idDocumentReference.docStatusShort description preliminary | final | amended | entered-in-error DefinitionThe status of the underlying document. The document that is pointed to might be in various lifecycle states. Status of the underlying document. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | Element idDocumentReference.typeShort description Kind of document (LOINC if possible) DefinitionSpecifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents. Precise type of clinical document. DocumentTypeValueSet (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 0..* | CodeableConcept | Element idDocumentReference.categoryShort description Categorization of document Alternate namesclaxs DefinitionA categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching. High-level kind of a clinical document at a macro level. DocumentClassValueSet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | Σ C | 0..1 | Reference(Device | Group | Patient | Practitioner) | Element idDocumentReference.subjectShort description Who/what is the subject of the document DefinitionWho or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | Patient | Practitioner) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | Σ | 0..1 | instant | Element idDocumentReference.dateShort description When this document reference was created Alternate namesindexed DefinitionWhen the document reference was created. Referencing/indexing time is used for tracking, organizing versions and searching. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author | Σ C | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idDocumentReference.authorShort description Who and/or what authored the document DefinitionIdentifies who is responsible for adding the information to the document. Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| authenticator | C | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Element idDocumentReference.authenticatorShort description Who/what authenticated the document DefinitionWhich person or organization authenticates that this document is valid. Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. Reference(Organization | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| custodian | C | 0..1 | Reference(Organization) | Element idDocumentReference.custodianShort description Organization which maintains the document DefinitionIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document. Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relatesTo | Σ | 0..* | BackboneElement | Element idDocumentReference.relatesToShort description Relationships to other documents DefinitionRelationships that this document has with other document references that already exist. This element is labeled as a modifier because documents that append to other documents are incomplete on their own. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.relatesTo.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.relatesTo.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.relatesTo.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | codeBinding | Element idDocumentReference.relatesTo.codeShort description replaces | transforms | signs | appends DefinitionThe type of relationship that this document has with anther document. If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. The type of relationship between documents. DocumentRelationshipType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| target | Σ C | 1..1 | Reference(DocumentReference) | Element idDocumentReference.relatesTo.targetShort description Target of the relationship DefinitionThe target document of this relationship. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | Σ | 0..1 | string | Element idDocumentReference.descriptionShort description Human-readable description DefinitionHuman-readable description of the source document. Helps humans to assess whether the document is of interest. What the document is about, a terse summary of the document. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| securityLabel | Σ | 0..* | CodeableConceptBinding | Element idDocumentReference.securityLabelShort description Document security-tags DefinitionA set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| content | Σ | 1..* | BackboneElement | Element idDocumentReference.contentShort description Document referenced DefinitionThe document and format referenced. There may be multiple content element repetitions, each with a different format. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.content.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.content.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.content.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| attachment | Σ C | 1..1 | Attachment | Element idDocumentReference.content.attachmentShort description Where to access the document DefinitionThe document or URL of the document along with critical metadata to prove content has integrity. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| format | Σ | 0..1 | CodingBinding | Element idDocumentReference.content.formatShort description Format/content rules for the document DefinitionAn identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI. Document Format Codes. DocumentReferenceFormatCodeSet (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| context | Σ | 0..1 | BackboneElement | Element idDocumentReference.contextShort description Clinical context of document DefinitionThe clinical context in which the document was prepared. These values are primarily added to help with searching for interesting/relevant documents. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDocumentReference.context.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.context.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idDocumentReference.context.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | C | 0..* | Reference(Encounter | EpisodeOfCare) | Element idDocumentReference.context.encounterShort description Context of the document content DefinitionDescribes the clinical encounter or type of care that the document content is associated with. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Encounter | EpisodeOfCare) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| event | 0..* | CodeableConcept | Element idDocumentReference.context.eventShort description Main clinical acts documented DefinitionThis list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation. This list of codes represents the main clinical acts being documented. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| period | Σ C | 0..1 | Period | Element idDocumentReference.context.periodShort description Time of service that is being documented DefinitionThe time period over which the service that is described by the document was provided. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| facilityType | 0..1 | CodeableConcept | Element idDocumentReference.context.facilityTypeShort description Kind of facility where patient was seen DefinitionThe kind of facility where the patient was seen. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. XDS Facility Type. FacilityTypeCodeValueSet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| practiceSetting | 0..1 | CodeableConcept | Element idDocumentReference.context.practiceSettingShort description Additional details about where the content was created (e.g. clinical specialty) DefinitionThis property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC. Additional details about where the content was created (e.g. clinical specialty). PracticeSettingCodeValueSet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| sourcePatientInfo | C | 0..1 | Reference(Patient) | Element idDocumentReference.context.sourcePatientInfoShort description Patient demographics from source DefinitionThe Patient Information as known when the document was published. May be a reference to a version specific, or contained. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| related | C | 0..* | Reference(Resource) | Element idDocumentReference.context.relatedShort description Related identifiers or resources DefinitionRelated identifiers or resources associated with the DocumentReference. May be identifiers or resources that caused the DocumentReference or referenced Document to be created. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Additional Guidance
subject
SHOULD be present if related to a patient. Reference to the Patient this data file is pertaining to. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
author
SHOULD reference the organization responsible for creating the data file, preferably by ODS code."performer": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "REP" } } ],
description
Human readable description for the data file. NOTE: this is being used in place of DocumentReference.type until suitable LOINC or SNOMED CT concepts are identified for the file types expected."description": "Phenotype Report",
content
SHOULD be a DRS compatible reference to the data file."content": [ { "attachment": { "contentType": "application/json", "url": "drs://drs.genomicsengland.nhs.uk/ga4gh/drs/v1/objects/42375e7d-071c-4eb3-b1c8-cec11e245cf0", "title": "PharmCAT JSON report" } } ],
context
In all cases the DocumentReference SHOULD reference the DNA Specimen from which the data originated, where available, and the ServiceRequest which triggered the capture of the data.The DiagnosticReport using the data file SHOULD reference the DocumentReference via the DiagnosticReport.extension:supporting-info element. This guidance will be updated upon release of the R5 backport of DiagnosticReport.media, allowing references to DocumentReference. Once backported, the DiagnosticReport.media.link SHOULD be used to reference the DocumentReference resources for data files analysed for the report instead.
"context": { "related": [ { "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-NewFollowupTest-Example" }, { "reference": "Specimen/Specimen-BloodEDTA-Example" } ] }
StructureDefinition UKCore-FamilyMemberHistory
For collecting relevant Family Member History to aid interpretation of Genomic results. This is limited to collection of Pedigree information. The FamilyMemberHistory resource is not to be used to record participants involved in testing, e.g. in the case of Duo/Trio scenarios (in this case the RelatedPerson resource SHOULD be used instead.
The Genomics FamilyMemberHistory is currently pending Clinical and Technical Assurance of the base UKCore resource. Once this profile becomes active in UKCore its suitability for use and need for profiling within Genomics will be assessed.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-FamilyMemberHistory | UKCore | trial-use |
| UKCoreFamilyMemberHistory (FamilyMemberHistory) | C | FamilyMemberHistory | There are no (further) constraints on this element Element idFamilyMemberHistoryShort description Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| associatedEncounter | C | 0..1 | Extension(Reference(Encounter)) | Element idFamilyMemberHistory.extension:associatedEncounterShort description This extension is used to reference an associated encounter. Alternate namesextensions, user content DefinitionAn associated encounter reference. 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. Extension(Reference(Encounter)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| participantR5 | C | 0..* | Extension(Complex) | Element idFamilyMemberHistory.extension:participantR5Short description Who or what participated in the activities related to the family member history. This is a R5 backport. Alternate namesextensions, user content DefinitionAn extension to record who or what participated in the activities related to the family member history. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| function | C | 0..1 | ExtensionBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:functionShort description The type of involvement in the activities related to the family member history. Alternate namesextensions, user content DefinitionDistinguishes the type of involvement of the actor in the activities related to the family member history. 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. ParticipationRoleType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. functionMappings
| |||
| value[x] | 1..1 | Element idFamilyMemberHistory.extension:participantR5.extension:function.value[x]Short description The type of involvement in the activities related to the family member history DefinitionThis FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| actor | C | 1..1 | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actorShort description Who or what participated in the activities related to the family member history. Alternate namesextensions, user content DefinitionIndicates who or what participated in the activities related to the family member history. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. actorMappings
| |||
| value[x] | 1..1 | Element idFamilyMemberHistory.extension:participantR5.extension:actor.value[x]Short description Who or what participated in the activities related to the family member history DefinitionA reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueReference | Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Data typeReference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participantMappings
| |||
| value[x] | 0..0 | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifierShort description External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). 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. For example, multiple Patient and a Person resource instance might share the same social insurance number. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idFamilyMemberHistory.statusShort description A code specifying the status of the record of the family history of a specific family member. DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record. FamilyHistoryStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| dataAbsentReason | Σ | 0..1 | CodeableConceptBinding | Element idFamilyMemberHistory.dataAbsentReasonShort description subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available. FamilyHistoryAbsentReason (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| patient | S Σ C | 1..1 | Reference(Patient) | Element idFamilyMemberHistory.patientShort description The person who this history concerns. Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | S Σ | 0..1 | dateTime | Element idFamilyMemberHistory.dateShort description The date (and possibly time) when the family member history was recorded or last updated. DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This should be captured even if the same as the date on the List aggregating the full family history. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | S Σ | 0..1 | string | Element idFamilyMemberHistory.nameShort description Allows greater ease in ensuring the same person is being talked about. DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationship | S Σ | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.relationshipShort description Relationship to the subject. DefinitionThe type of relationship this person has to the patient (father, mother, brother etc.). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between the patient and the related person being described in the family member history. UKCorePersonRelationshipType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sexShort description male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration. AdministrativeGender (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| born[x] | C | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x]Short description (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age. The cardinality or value of this element may be affected by these constraints: ele-1, fhs-1 Constraints
| |||
| bornDate | date | There are no (further) constraints on this element Data type | ||||
| bornPeriod | Period | There are no (further) constraints on this element Data type | ||||
| bornString | string | There are no (further) constraints on this element Data type | ||||
| age[x] | Σ C | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x]Short description (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not. The cardinality or value of this element may be affected by these constraints: ele-1, fhs-1 Constraints
| |||
| ageAge | Age | There are no (further) constraints on this element Data type | ||||
| ageRange | Range | There are no (further) constraints on this element Data type | ||||
| ageString | string | There are no (further) constraints on this element Data type | ||||
| estimatedAge | Σ C | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAgeShort description Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not The cardinality or value of this element may be affected by these constraints: ele-1, fhs-2 Constraints
| ||
| deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x]Short description Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| deceasedAge | Age | There are no (further) constraints on this element Data type | ||||
| deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| deceasedDate | date | There are no (further) constraints on this element Data type | ||||
| deceasedRange | Range | There are no (further) constraints on this element Data type | ||||
| deceasedString | string | There are no (further) constraints on this element Data type | ||||
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCodeShort description Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done. SNOMEDCTClinicalFindings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(AllergyIntolerance | Condition | DiagnosticReport | DocumentReference | Observation | QuestionnaireResponse) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReferenceShort description Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(AllergyIntolerance | Condition | DiagnosticReport | DocumentReference | Observation | QuestionnaireResponse) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.noteShort description General note about related person DefinitionThis property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| condition | S | 0..* | BackboneElement | Element idFamilyMemberHistory.conditionShort description Condition that the related person had. DefinitionThe significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.condition.codeShort description Condition suffered by relation DefinitionThe actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identification of the Condition or diagnosis. Condition/Problem/DiagnosisCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| outcome | 0..1 | CodeableConceptBinding | Element idFamilyMemberHistory.condition.outcomeShort description deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. ConditionOutcomeCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeathShort description Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| onset[x] | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.onset[x]Short description When condition first manifested DefinitionEither the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. Age of onset of a condition in relatives is predictive of risk for the patient. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| onsetAge | Age | There are no (further) constraints on this element Data type | ||||
| onsetPeriod | Period | There are no (further) constraints on this element Data type | ||||
| onsetRange | Range | There are no (further) constraints on this element Data type | ||||
| onsetString | string | There are no (further) constraints on this element Data type | ||||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.noteShort description Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| FamilyMemberHistory | Pedigree details/diagram, Disease penetrance | N/A not in scope for HL7v2, could be added as additional DG1 segments related to relatives (representation of family history in HL7v2 still pending investigation) |
Additional Guidance
extension:genetics-observation
An extension on the FamilyMemberHistory resource to include Observations relevant to Genomic testing/interpretation."extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation", "valueReference": { "reference": "Observation/Observation-BloodPressure-Example" } } ],
identifier
This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents). If a local identifier is used, an assigner SHALL be provided. The FamilyMemberHistory.identifier field SHALL match the identifier used for a RelatedPerson resource if the same person is being referenced."identifier": { "system": "urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24", "value": "FT-RWT13521", "assigner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RAX" } } } }
status
Used to mark the completeness of a given family member's clinical history. If the history of a family member is expected but no history could be obtained, this element SHOULD be filled with 'health-unknown'.Assertions regarding absence of relevant history SHOULD follow guidance within the HL7 FHIR R4 FamilyMemberHistory resource
"status": "completed",
patient
SHALL be present. Reference to the associated proband Patient for which this family history is being obtained. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } }
relationship
SHALL be present. Relationship between the person the FamilyMemberHistory references and the proband Patient. Clinical histories for each family member are expected to be recorded in separate FamilyMemberHistory resources. If multiple resources are required, both FamilyMemberHistory and related clinical artifacts such as Condition/Observation resources, these MAY be contained within a List resource to improve readability."relationship": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "PRN", "display": "parent" } ] }
StructureDefinition Group
For recording patients which are part of a family unit, assigned a Pedigree Number by a clinical genetics service.
Pedigree numbers are generated upon referral of a patient to clinical genetics and are applied to all forms of correspondence from patient letters to genomic orders. These are therefore owned by clinical genetics and referenced back by processing labs.
Some pedigree numbers reference the relationship between the family members to the original proband, other just have a general pedigree number which relates to all family members. There is disparity in approach across the GU.
Patients can multiple pedigree numbers. Single pedigree numbers can also span multiple families with a common patient.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Group | HL7 International | trial-use |
| Group | C | DomainResource | Element idGroupShort description Group of multiple entities DefinitionRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. 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.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idGroup.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idGroup.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idGroup.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idGroup.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idGroup.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idGroup.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idGroup.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idGroup.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idGroup.identifierShort description Unique id DefinitionA unique business identifier for this group. Allows the group to be referenced from external specifications. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ | 0..1 | boolean | Element idGroup.activeShort description Whether this group's record is in active use DefinitionIndicates whether the record for the group is available for use or is merely being retained for historical purposes. Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists). This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | codeBinding | Element idGroup.typeShort description person | animal | practitioner | device | medication | substance DefinitionIdentifies the broad classification of the kind of resources the group includes. Identifies what type of resources the group is made up of. Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.). Types of resources that are part of group. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actual | Σ C | 1..1 | boolean | Element idGroup.actualShort description Descriptive or actual DefinitionIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag. The cardinality or value of this element may be affected by these constraints: ele-1, grp-1 Constraints
| ||
| code | Σ | 0..1 | CodeableConcept | Element idGroup.codeShort description Kind of Group members DefinitionProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc. This would generally be omitted for Person resources. Kind of particular resource; e.g. cow, syringe, lake, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 0..1 | string | Element idGroup.nameShort description Label for Group DefinitionA label assigned to the group for human identification and communication. Used to identify the group in human communication. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| quantity | Σ | 0..1 | unsignedInt | Element idGroup.quantityShort description Number of members DefinitionA count of the number of resource instances that are part of the group. Group size is a common defining characteristic. Note that the quantity may be less than the number of members if some of the members are not active. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| managingEntity | Σ C | 0..1 | Reference(Organization | Practitioner | PractitionerRole | RelatedPerson) | Element idGroup.managingEntityShort description Entity that is the custodian of the Group's definition DefinitionEntity responsible for defining and maintaining Group characteristics and/or registered members. 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. Reference(Organization | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| characteristic | 0..* | BackboneElement | Element idGroup.characteristicShort description Include / Exclude group members by Trait DefinitionIdentifies traits whose presence r absence is shared by members of the group. Needs to be a generic mechanism for identifying what individuals can be part of a group. All the identified characteristics must be true for an entity to a member of the group. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idGroup.characteristic.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idGroup.characteristic.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idGroup.characteristic.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | 1..1 | CodeableConcept | Element idGroup.characteristic.codeShort description Kind of characteristic DefinitionA code that identifies the kind of trait being asserted. Need a formal way of identifying the characteristic being described. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| value[x] | 1..1 | Element idGroup.characteristic.value[x]Short description Value held by characteristic DefinitionThe value of the trait that holds (or does not hold - see 'exclude') for members of the group. The value of the characteristic is what determines group membership. For Range, it means members of the group have a value that falls somewhere within the specified range. Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueBoolean | boolean | Data type | ||||
| valueCodeableConcept | CodeableConcept | Data type | ||||
| valueQuantity | Quantity | Data type | ||||
| valueRange | Range | Data type | ||||
| valueReference | Reference | Data type | ||||
| exclude | 1..1 | boolean | Element idGroup.characteristic.excludeShort description Group includes or excludes DefinitionIf true, indicates the characteristic is one that is NOT held by members of the group. Sometimes group membership is determined by characteristics not possessed. This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| period | C | 0..1 | Period | Element idGroup.characteristic.periodShort description Period over which characteristic is tested DefinitionThe period over which the characteristic is tested; e.g. the patient had an operation during the month of June. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| member | C | 0..* | BackboneElement | Element idGroup.memberShort description Who or what is in group DefinitionIdentifies the resource instances that are members of the group. Often the only thing of interest about a group is "who's in it". The cardinality or value of this element may be affected by these constraints: ele-1, grp-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idGroup.member.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idGroup.member.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idGroup.member.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| entity | C | 1..1 | Reference(Device | Group | Medication | Patient | Practitioner | PractitionerRole | Substance) | Element idGroup.member.entityShort description Reference to the group member DefinitionA 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | Medication | Patient | Practitioner | PractitionerRole | Substance) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | C | 0..1 | Period | Element idGroup.member.periodShort description Period member belonged to the group DefinitionThe period that the member was in the group, if known. Need to track who was in a group at a particular time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The member is in the group at this time The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| inactive | 0..1 | boolean | Element idGroup.member.inactiveShort description If member is no longer in group DefinitionA flag to indicate that the member is no longer in the group, but previously may have been a member. Sometimes you don't know when someone stopped being in a group, but not when. Members are considered active unless explicitly specified otherwise The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Group.identifier | Patient - Pedigree/Family Identifier | Additional identifiers under PID-3 (TBC) |
Additional Guidance
identifier
SHALL be present. The Pedigree Number assigned by the clinical genetics service. The central pedigree NamingSystem SHOULD be used to support cross region sharing of pedigree/family unit information."identifier": [ { "system": "https://fhir.nhs.uk/Id/genomics-pedigree-number", "value": "P12345" } ],
type
For Pedigrees a fixed value of "person" SHALL be used"type": "person",
actual
For Pedigrees a fixed value of true SHALL be used"actual": true,
member
SHALL be present. `entity` SHOULD be a reference to a Patient resource within the GOMS infrastructure or a unique identifier where this is not possible. `period` SHOULD record the date the member was added to the Group. `inactive` MAY be used to record entities which are no longer members of the group, though if an individual was added to a Group in error and should never have been part of the group, the entity SHALL be removed entirely."member": [ { "entity": { "reference": "Patient/Patient-PheobeSmitham-Example" }, "period": { "start": "2023-10-01" } }, { "entity": { "reference": "Patient/Patient-PheobeSmithamFather-Example" }, "period": { "start": "2023-10-01" } }, { "entity": { "reference": "Patient/Patient-PheobeSmithamMother-Example" }, "period": { "start": "2025-10-01", "end": "2025-10-01" }, "inactive": true } ]
StructureDefinition UKCore-Observation
Used to represent the bulk of clinical information to be sent alongside a Genomic Test Order, as well as clinical results included within structured Diagnostic Reports.
Observations within Genomics are used to represent a point-in-time observation made about a patient or specimen. This means Observations SHOULD NOT be updated post-submission unless the original Observation has been entered in error or incorrectly coded (in this case, the appropriate status SHALL be used, e.g. entered-in-error or corrected).
For new observations which invalidate previous observations made about a patient, a new Observation resource SHOULD be created, the new observation MAY reference the invalidated observation via the observation-replaces extension.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation | UKCore | trial-use |
| UKCoreObservation (Observation) | C | Observation | There are no (further) constraints on this element Element idObservationShort description Measurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservation.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idObservation.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idObservation.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservation.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idObservation.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idObservation.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idObservation.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| triggeredByR5 | C | 0..* | Extension(Complex) | Element idObservation.extension:triggeredByR5Short description Triggering observation(s). This is a R5 backport. Alternate namesextensions, user content DefinitionIdentifies the observation(s) that triggered the performance of this observation. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 2..* | Extension | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| observation | C | 1..1 | Extension | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:observationShort description Triggering observation Alternate namesextensions, user content DefinitionReference to the triggering observation. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:observation.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:observation.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:observation.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. observationMappings
| |||
| value[x] | 1..1 | Element idObservation.extension:triggeredByR5.extension:observation.value[x]Short description Triggering observation. DefinitionA reference to the triggering observation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueReference | Reference(Observation) | There are no (further) constraints on this element Data type | ||||
| type | C | 1..1 | ExtensionBinding | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:typeShort description reflex | repeat | re-run Alternate namesextensions, user content DefinitionThe type of trigger. Reflex | Repeat | Re-run. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:type.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:type.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. typeMappings
| |||
| value[x] | 1..1 | Element idObservation.extension:triggeredByR5.extension:type.value[x]Short description The type of trigger. Reflex | Repeat | Re-run DefinitionThe type of trigger. Reflex | Repeat | Re-run The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueCode | code | There are no (further) constraints on this element Data type | ||||
| reason | C | 0..1 | Extension | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:reasonShort description Reason that the observation was triggered Alternate namesextensions, user content DefinitionProvides the reason why this observation was performed as a result of the observation(s) referenced. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:reason.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:reason.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.extension:reason.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. reasonMappings
| |||
| value[x] | 1..1 | Element idObservation.extension:triggeredByR5.extension:reason.value[x]Short description Reason that the observation was triggered. DefinitionProvides the reason why this observation was performed as a result of the observation referenced. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredByMappings
| |||
| value[x] | 0..0 | There are no (further) constraints on this element Element idObservation.extension:triggeredByR5.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| bodyStructureR5 | C | 0..1 | Extension(Reference(BodyStructure)) | Element idObservation.extension:bodyStructureR5Short description Observed body structure. This is a R5 backport. Alternate namesextensions, user content DefinitionIndicates the body structure on the subject's body where the observation was made (i.e. the target site). 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. Extension(Reference(BodyStructure)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idObservation.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idObservation.identifierShort description Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element idObservation.basedOnShort description Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| partOf | Σ C | 0..* | Reference(ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure) | There are no (further) constraints on this element Element idObservation.partOfShort description Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idObservation.statusShort description The status of the result value. DefinitionThe status of the result value. Need to track the status of individual results. Some results are finalized before the whole report is finalized. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status of an observation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | S | 0..* | CodeableConceptBinding | Element idObservation.categoryShort description A code that classifies the general type of observation being made. DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 1..1 | CodeableConceptBinding | Element idObservation.codeShort description The type of observation (code / type). Alternate namesName DefinitionDescribes what was observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. A code from the SNOMED Clinical Terminology UK coding system describing a type of observation UKCoreObservationType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 0..1 | Reference(Device | Group | Location | Patient) | Element idObservation.subjectShort description Who and / or what the observation is about. DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. Reference(Device | Group | Location | Patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | Σ C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idObservation.focusShort description What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idObservation.encounterShort description Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| effective[x] | S Σ | 0..1 | Element idObservation.effective[x]Short description A clinically relevant time / time-period for observation. Alternate namesOccurrence DefinitionThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. Knowing when an observation was deemed true is important to its relevance as well as determining trends. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectiveDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| effectiveInstant | instant | There are no (further) constraints on this element Data type | ||||
| effectivePeriod | Period | There are no (further) constraints on this element Data type | ||||
| effectiveTiming | Timing | There are no (further) constraints on this element Data type | ||||
| issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element idObservation.issuedShort description Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | S Σ C | 0..* | Reference(CareTeam | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idObservation.performerShort description Who is responsible for the observation. DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareTeam | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | S Σ C | 0..1 | Element idObservation.value[x]Short description The actual observed result. DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 Constraints
| |||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| valueInteger | integer | There are no (further) constraints on this element Data type | ||||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||||
| valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| valueRange | Range | There are no (further) constraints on this element Data type | ||||
| valueRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueTime | time | There are no (further) constraints on this element Data type | ||||
| dataAbsentReason | C | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.dataAbsentReasonShort description Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Codes specifying why the result ( The cardinality or value of this element may be affected by these constraints: ele-1, obs-6 Constraints
| ||
| interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.interpretationShort description High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idObservation.noteShort description Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| bodySite | 0..1 | CodeableConceptBinding | Element idObservation.bodySiteShort description Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| method | 0..1 | CodeableConceptBinding | Element idObservation.methodShort description How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. ObservationMethods (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| specimen | C | 0..1 | Reference(Specimen) | There are no (further) constraints on this element Element idObservation.specimenShort description Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| device | C | 0..1 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element idObservation.deviceShort description (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| referenceRange | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idObservation.referenceRangeShort description Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idObservation.referenceRange.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idObservation.referenceRange.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idObservation.referenceRange.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| low | C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idObservation.referenceRange.lowShort description Low Range, if relevant DefinitionThe value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1, obs-3 Constraints
| ||
| high | C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idObservation.referenceRange.highShort description High Range, if relevant DefinitionThe value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1, obs-3 Constraints
| ||
| type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.referenceRange.typeShort description Reference range qualifier DefinitionCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. Code for the meaning of a reference range. ObservationReferenceRangeMeaningCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| appliesTo | 0..* | CodeableConcept | There are no (further) constraints on this element Element idObservation.referenceRange.appliesToShort description Reference range population DefinitionCodes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple Need to be able to identify the target population for proper interpretation. This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. Codes identifying the population the reference range applies to. ObservationReferenceRangeAppliesToCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| age | C | 0..1 | Range | There are no (further) constraints on this element Element idObservation.referenceRange.ageShort description Applicable age range, if relevant DefinitionThe age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. Some analytes vary greatly over age. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | 0..1 | string | There are no (further) constraints on this element Element idObservation.referenceRange.textShort description Text based reference range in an observation DefinitionText based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| hasMember | Σ C | 0..* | Reference(MolecularSequence | Observation | QuestionnaireResponse) | There are no (further) constraints on this element Element idObservation.hasMemberShort description Related resource that belongs to the Observation group DefinitionThis observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(MolecularSequence | Observation | QuestionnaireResponse) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| derivedFrom | Σ C | 0..* | Reference(DocumentReference | ImagingStudy | Media | MolecularSequence | Observation | QuestionnaireResponse) | There are no (further) constraints on this element Element idObservation.derivedFromShort description Related measurements the observation is made from DefinitionThe target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. Reference(DocumentReference | ImagingStudy | Media | MolecularSequence | Observation | QuestionnaireResponse) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| component | S Σ | 0..* | BackboneElement | Element idObservation.componentShort description Component / sub results. DefinitionSome observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. For a discussion on the ways Observations can be assembled in groups together see Notes below. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idObservation.component.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idObservation.component.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | CodeableConceptBinding | Element idObservation.component.codeShort description Type of component observation (code / type) DefinitionDescribes what was observed. Sometimes this is called the observation "code". Knowing what kind of observation is being made is essential to understanding the observation. All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. A code from the SNOMED Clinical Terminology UK coding system describing a type of observation UKCoreObservationType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ | 0..1 | There are no (further) constraints on this element Element idObservation.component.value[x]Short description Actual component result DefinitionThe information determined as a result of making the observation, if the information has a simple value. An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| valueInteger | integer | There are no (further) constraints on this element Data type | ||||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||||
| valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| valueRange | Range | There are no (further) constraints on this element Data type | ||||
| valueRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueTime | time | There are no (further) constraints on this element Data type | ||||
| dataAbsentReason | C | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component.dataAbsentReasonShort description Why the component result is missing DefinitionProvides a reason why the expected value in the element Observation.component.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. Codes specifying why the result ( The cardinality or value of this element may be affected by these constraints: ele-1, obs-6 Constraints
| ||
| interpretation | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.component.interpretationShort description High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| referenceRange | 0..* | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component.referenceRangeShort description Provides guide for interpretation of component result DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Observation | Raw specimen/biopsy - Additional specimen/biopsy information, Extracted specimen - Additional specimen information, Further clinical information | OBX segments (may be attached to SPM) |
| Observation.code | Patient - Sexual orientation, Patient - Karyotypic sex, Patient - Pregnancy status, Patient - Fetal karyotypic sex, Patient - Is from consanguinous union, Fetus - Karyotypic sex, Fetus - Is testing for fetal loss from 24 weeks of gestation, PLCM activity - DNA concentration, PLCM activity - DNA quantification, PLCM activity - Test outcome code (Many), Raw specimen/biopsy - Taken alive/post mortem, Diabetic complications, Has absent reflexes | OBX-5 with appropriate SNOMED/READ/LOINC code |
| Observation.component | Patient - Pregnancy gestation period, Patient - Fetal gestation, Patient - Estimated Delivery Date (EDD), Patient - Pregnancy type, Absent reflexes detail | OBX-14 (compared with other ORC segments), OBR segments with appropriate codes |
| Observation.value\[x\] | Patient - Height (m), Raw specimen/biopsy - Skin/Bone affected status, Raw specimen/biopsy - Blasts %, Raw specimen/biopsy - Neoplastic cell content (%), Raw specimen/biopsy - Necrosis, Raw specimen/biopsy - Nucleated cell count, Raw specimen/biopsy - Tumour cellularity, Raw specimen/biopsy - Maternal cell contamination (MCC), Previous non genomic report - Test result value comparator, Previous non genomic report - Test result value unit of measure, Genomic ethnicity, ISTH BAT score, MODY probability calculator score, Patient BMI at time of genomic test request, Patient BMI at time of diagnosis, Maternal BMI at time of request, Paternal BMI at time of request, Birth weight | OBX-5/6 |
| Observation.referenceRange.low | Previous non genomic report - Test result reference range low | OBX-7 (before operator) |
| Observation.referenceRange.high | Previous non genomic report - Test result reference range high | OBX-7 (after operator) |
| Observation.method | Previous non genomic report - Test result test method | OBX-17 |
| Observation.referenceRange.text | Previous non genomic report - Test result reference range text | OBX-7 |
| Observation.interpretation | Previous non genomic report - Test result clinical summary | OBX-8 |
| Observation.bodySite | Subcutaneous fat loss areas, Increased fat deposition areas | OBX-5 |
Additional Guidance
- extension:observation-replaces
- partOf
- status
- code
- subject
- focus
- effectiveDateTime
- value[x]
- component
extension:observation-replaces
A core extension on the base HL7 International Observation resource. Used to link to previous Observation resources which have been invalidated by this Observation instance, e.g. for cases where a previously present HPO term is now no longer applicable. For new observations which invalidate previous observations made about a patient, the new Observation resource SHOULD be created, and MAY reference the invalidated observation via the observation-replaces extension.
{
"url": "http://hl7.org/fhir/StructureDefinition/observation-replaces",
"valueReference": {
"reference": "Observation/Observation-IntellectualDisabilityMild-Example"
}
}
partOf
To record the device/software that generated an observation. Our recommendation is that this element SHOULD reference the Genomic Study Procedure profile and its extension:genomic-study-analysis SHOULD reference the Procedure resource for the Genomic Study Analysis
"partOf": [ { "reference": "Procedure/Procedure-GenomicStudy-Example" } ]
status
SHOULD be marked as final for most observations unless corrected after submission. Observations within Genomics are used to represent a point-in-time observation made about a patient or specimen. This means Observations should not be updated post-submission unless the original Observation has been entered in error or incorrectly coded (in this case, the appropriate status SHALL be used, e.g. entered-in-error or corrected, respectively).
"status": "final",
code
SHALL be present. SNOMED CT coding is preferred, though it is expected that alternative codings will be used depending on the appropriateness for a particular observation e.g. HPO or other codings found within the HL7 International Genomic Reporting IG as their use may already be widespread within Genomics. If a SNOMED CT equivalent exists for a code regularly captured within another CodeSystem, additional 'coding' elements within 'code' SHOULD be provided to aid analytics.
"code": { "coding": [ { "system": "https://hpo.jax.org/app/", "code": "HP:0000105", "display": "Enlarged kidney" } ] },
subject
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
focus
For recording the Specimen the observation relates to, when the observation is not related to the patient from which the sample was taken e.g. Sample nucleated cell count.This can also be used for observations related to the state of the patient at the time of collection e.g. pregnancy status.
"focus": { "reference": "Specimen/Specimen-BloodEDTA-Example" },
effectiveDateTime
It is expected that all Observations SHOULD include the effective time the observation was made, if known, to aid interpretation."effectiveDateTime": "2022-07-11T09:00:00Z",
value[x]
The value element SHOULD use the most appropriate data type for the observation in question. Using preferred CodeSystems as specified within HL7 International FHIR R4 or the UK Core. For asserting absence of a particular condition/situation, the finding SHOULD be specified within the 'code' element and 'valueBoolean' set to 'false' or 'valueCodeableConcept' set to an appropriate qualifier value code from SNOMED CT. For an assertion of a particular situation being present, e.g. a Condition or Procedure having been performed, these SHOULD be collected within the relevant clinical resources, alongside additional information needed to inform interpretation."valueQuantity": { "value": 6.5, "system": "http://unitsofmeasure.org", "code": "10*12/L" }
component
SHOULD be used to group qualifiers of an observation. In particular, details regarding observations related to a pregnancy SHOULD be added as components on a pregnancy status observation.Examples of how pregnancy information can be captured within Observations (pregnancy status with EDD, gestation etc. recorded as components) will be added to the Fetus Management Clinical Scenario.
"component": [ { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "720451000000102", "display": "Assisted conception" } ] } }, { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "226081000000107", "display": "Gestational age" } ] }, "valueQuantity": { "value": 87, "unit": "day", "system": "http://unitsofmeasure.org", "code": "d" } }, { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "161714006", "display": "Estimated date of delivery" } ] }, "valueDateTime": "2024-05-01" } ],
StructureDefinition OperationOutcome
The Genomics OperationOutcome is the same as provided within FHIR R4. The FHIR R4 OperationOutcome is provided below for completeness.
OperationOutcomes are expected for any create or update operations made on the server resulting in validation messages (or any create or update operations made within a transaction bundle). It is not expected that connecting systems would need to construct OperationOutcome resources or submit these to the server, though key elements within the resource are detailed here for receiving systems.
It is expected that all issue codes raised by the Genomic Medicine Service will fall under existing codes bound in the below resource. If further codes are needed, these will be promoted to UK Core for release in a future ballot/sprint.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/OperationOutcome | HL7 International | trial-use |
| OperationOutcome | C | DomainResource | Element idOperationOutcomeShort description Information about the success/failure of an action DefinitionA collection of error, warning, or information messages that result from a system action. Can result from the failure of a REST call or be part of the response message returned from a request message.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOperationOutcome.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOperationOutcome.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idOperationOutcome.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idOperationOutcome.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| issue | Σ | 1..* | BackboneElement | Element idOperationOutcome.issueShort description A single issue associated with the action DefinitionAn error, warning, or information message that results from a system action. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| severity | Σ | 1..1 | codeBinding | Element idOperationOutcome.issue.severityShort description fatal | error | warning | information DefinitionIndicates whether the issue indicates a variation from successful processing. Indicates how relevant the issue is to the overall success of the action. This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. How the issue affects the success of the action. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | codeBinding | Element idOperationOutcome.issue.codeShort description Error or warning code DefinitionDescribes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element. Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned. Note that FHIR strings SHALL NOT exceed 1MB in size A code that describes the type of issue. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| details | Σ | 0..1 | CodeableConcept | Element idOperationOutcome.issue.detailsShort description Additional details about the error DefinitionAdditional details about the error. This may be a text description of the error or a system code that identifies the error. A human readable description of the error issue SHOULD be placed in details.text. A code that provides details as the exact issue. OperationOutcomeCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| diagnostics | Σ | 0..1 | string | Element idOperationOutcome.issue.diagnosticsShort description Additional diagnostic information about the issue DefinitionAdditional diagnostic information about the issue. This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ | 0..* | string | Element idOperationOutcome.issue.locationShort description Deprecated: Path of element(s) related to issue DefinitionThis element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name. Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| expression | Σ | 0..* | string | Element idOperationOutcome.issue.expressionShort description FHIRPath of element(s) related to issue DefinitionA simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Additional Guidance
issue
An issue element will be included within the OperationOutcome for each issue that needs to be communicated to the requesting system, e.g. errors, warnings or informational messages. Appropriate 'severity' and 'code' codes will be assigned to help categorization of an messages returned, using the standard HL7 bound ValueSets.The diagnostics field will be used to present a human readable version of the message and location will be used to detail the location within the request payload that resulted in the associated issue/message.
If an error or warning is returned, the 'details' element will be populated with any validation specific messages. Details of the systems and codes used for these messages will be determined by the validation package used by the central order management broker (this is still to be determined at the time of publication).
"issue":[ { "severity":"error", "code":"processing", "details":{ "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/operation-outcome", "code": "MSG_LOCAL_FAIL", "display": "Unable to resolve local reference to resource Patient/Patient-MeirLieberman-Example" } ] }, "diagnostics": "Validation errors occurred during processing", "location": [ "Bundle.entry[1].resource.ofType(ServiceRequest)" ] } ]
StructureDefinition UKCore-Organization
Organization is not expected to be sent within Test Order or other interactions with the central GMS. Instead, client systems SHOULD strive to reference organizations via their ODS code and display name only.
The below profile is provided for information, if referencing by ODS code is intractable (though repeated issues with requester ability to reference via ODS code SHOULD be reported to the NHS England Genomic Unit for investigation).
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | UKCore | trial-use |
| UKCoreOrganization (Organization) | C | Organization | There are no (further) constraints on this element Element idOrganizationShort description A grouping of people or organizations with a common purpose DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| mainLocation | C | 0..1 | Extension(Reference(Location)) | Element idOrganization.extension:mainLocationShort description The main location of the organisation. Alternate namesextensions, user content DefinitionThe main location of the organisation. 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. Extension(Reference(Location)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| organizationPeriod | C | 0..1 | Extension(Period) | Element idOrganization.extension:organizationPeriodShort description The date range that this organization SHOULD be considered available. Alternate namesextensions, user content DefinitionThe date range that this organization SHOULD be considered available. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/StructureDefinition/organization-period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.extension:organizationPeriod.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.extension:organizationPeriod.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.extension:organizationPeriod.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/organization-periodMappings
| |||
| value[x] | 1..1 | Element idOrganization.extension:organizationPeriod.value[x]Short description The date range that this organization SHOULD be considered available. DefinitionThe date range that this organization SHOULD be considered available. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | S Σ C | 0..* | Identifier | Element idOrganization.identifierShort description Identifies this organization across multiple systems. DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| odsOrganisationCode | Σ C | 0..1 | Identifier | Element idOrganization.identifier:odsOrganisationCodeShort description Organisation Data Service code DefinitionIdentifier code supplier by the Organisation Data Service. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganization.identifier:odsOrganisationCode.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/ods-organization-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier:odsOrganisationCode.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| odsSiteCode | Σ C | 0..1 | Identifier | Element idOrganization.identifier:odsSiteCodeShort description ODS Site code to identify the organisation at site level DefinitionODS Site code to identify the organisation at site level. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idOrganization.identifier:odsSiteCode.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/ods-site-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier:odsSiteCode.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | S Σ ?! | 0..1 | boolean | Element idOrganization.activeShort description Identifies this organization across multiple systems. DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..* | CodeableConceptBinding | Element idOrganization.typeShort description Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | S Σ C | 0..1 | string | Element idOrganization.nameShort description A name associated with the organization. DefinitionA name associated with the organization. Need to use the name as the label of the organization. If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. The cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints
| ||
| alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.aliasShort description A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| telecom | S C | 0..* | ContactPoint | Element idOrganization.telecomShort description Contact details for the organization. DefinitionA contact detail for the organization. Human contact for the organization. The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. The cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints
| ||
| address | S C | 0..* | Address | Element idOrganization.addressShort description An address for the organization. DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. The cardinality or value of this element may be affected by these constraints: ele-1, org-2 Constraints
| ||
| partOf | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOfShort description The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contactShort description Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purposeShort description The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The purpose for which you would contact a contact party. ContactEntityType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.nameShort description A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecomShort description Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.addressShort description Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endpoint | C | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpointShort description Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Organization.name | Requestor - Organization name, Additional contact - Organization name, address and ODS code | ORC-21 |
| Organization.address | Requestor - Organization address, Additional contact - Organization address | ORC-22 |
| Organization.identifier | Requestor - Organization ODS code, Additional contact - Organization ODS code, Patient - GP Practice ODS Code, Previous genomic report - Report performer organisation ODS code, Previous genomic report - Original requester organisation ODS code, Previous non genomic report - Report performer organisation ODS code, Previous non genomic report - Original requester organisation ODS code | ORC-21.10, OBX-23.10 |
| Organization.partOf | PLCM activity - ODS code of commissioning region | N/A - not in scope for HL7v2 |
StructureDefinition UKCore-Patient
The focal resource for recording who a test order and genomic report are for.
It is expected that client's will need to post Patient resources to the central GMS as some demographic information specific to Genomics will not have been captured within other systems such as PDS.
For patients included within PDS, it is expected source systems SHOULD only send genomic specific information not recorded against PDS, e.g. extensions, such as birthSex, genomic specific identifiers and a link to the PDS record, as well as the NHS number identifier. (NOTE: examples provided for patient resources are fully expanded to illustrate how information should be structured but any infomation already recorded by PDS SHOULD NOT be duplicated within the genomic order management services). Querying patient demographic information, will be supported using the search parameters provided by the Genomic Order Management Service, whch will pass through parameters to PDS where demographics are stored against this system. Client systems will then be required to follow the PDS link within the Genomics-Patient record to retrieve the PDS patient.
It is a requirement on source systems that patient NHS numbers are traced and verified with PDS, if the patient is registered with PDS, before creation of patient resources on the Genomic Order Management broker
For patients not included on PDS, e.g. private/overseas patients or fetal records, the requester SHOULD send all information necessary to facilitate testing and interpretation of the request. Where this patient is later registered on PDS, identified through assignment of an NHS number, demographic details SHALL be stripped from the genomic record to avoid data duplication.
Alternatively, systems MAY opt to include pointers to the Patient resource on their local system, though the mechanism preferred by the NHS England Genomics Unit has yet to be decided.
Restricted Patients: PDS guidance on managing the data of sensitive patient shall be followed. Some patients are tagged as restricted and are sometimes known as sensitive patients. Restricted patients can be retrieved; however, location-sensitive fields such as address, telecom and generalPractitioner are removed.
The restricted flag can be found in the data under meta/security on the patient resource. See in Example: Patient-SensitivePatient-Example
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient | UKCore | trial-use |
| UKCorePatient (Patient) | C | Patient | There are no (further) constraints on this element Element idPatientShort description Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthPlace | C | 0..1 | Extension(Address) | Element idPatient.extension:birthPlaceShort description The registered place of birth of the patient. Alternate namesextensions, user content DefinitionThe registered place of birth of the patient. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/StructureDefinition/patient-birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:birthPlace.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:birthPlace.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/patient-birthPlaceMappings
| |||
| value[x] | 1..1 | Element idPatient.extension:birthPlace.value[x]Short description The registered place of birth of the patient. DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueAddress | Address | There are no (further) constraints on this element Data type | ||||
| birthSex | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:birthSexShort description The patient's phenotypic sex at birth. Alternate namesextensions, user content DefinitionThe patient's phenotypic sex at birth. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| cadavericDonor | C | 0..1 | Extension(boolean) | Element idPatient.extension:cadavericDonorShort description Post-mortem donor status. Alternate namesextensions, user content DefinitionFlag indicating whether the patient authorized the donation of body parts after death. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:cadavericDonor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:cadavericDonor.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:cadavericDonor.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/patient-cadavericDonorMappings
| |||
| value[x] | 1..1 | Element idPatient.extension:cadavericDonor.value[x]Short description Post-mortem donor status. DefinitionFlag indicating whether the patient authorized the donation of body parts after death. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| contactPreference | C | 0..1 | Extension(Complex) | Element idPatient.extension:contactPreferenceShort description The preferred method of contact, contact times and written communication format given by a Patient or Related Person. Alternate namesextensions, user content DefinitionThe preferred method of contact, contact times and written communication format given by a Patient or Related Person. 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| deathNotificationStatus | C | 0..1 | Extension(Complex) | Element idPatient.extension:deathNotificationStatusShort description The patient's death notification status. Alternate namesextensions, user content DefinitionThe patient's death notification status. 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| ethnicCategory | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:ethnicCategoryShort description The ethnicity of the subject. Alternate namesextensions, user content DefinitionThe ethnicity of the subject. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| fetalStatus | C | 0..1 | Extension(code) | Element idPatient.extension:fetalStatusShort description An indicator on the fetal status of a baby. Alternate namesextensions, user content DefinitionTypically used in maternity where the patient record may be created before the birth of the baby. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| residentialStatus | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:residentialStatusShort description The residential status of the patient. Alternate namesextensions, user content DefinitionThe residential status of the patient. For example if this patient is a UK resident. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| patientInterpreterRequired | C | 0..1 | Extension(boolean) | Element idPatient.extension:patientInterpreterRequiredShort description Indicator showing whether the patient needs an interpreter. Alternate namesextensions, user content DefinitionThis Patient requires an interpreter to communicate healthcare information to the practitioner. The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required. http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:patientInterpreterRequired.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:patientInterpreterRequired.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:patientInterpreterRequired.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/patient-interpreterRequiredMappings
| |||
| value[x] | 1..1 | Element idPatient.extension:patientInterpreterRequired.value[x]Short description Indicator showing whether the patient needs an interpreter DefinitionIndicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| nhsNumberUnavailableReason | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:nhsNumberUnavailableReasonShort description Reason why this Patient does not include an NHS Number identifier. Alternate namesextensions, user content DefinitionThe reason why a patient does not have an NHS Number. For example if this patient is an overseas patient. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | S Σ | 0..* | Identifier | Element idPatient.identifierShort description An identifier for this patient. DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| nhsNumber | Σ | 0..1 | Identifier | Element idPatient.identifier:nhsNumberShort description The patient's NHS number. DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| nhsNumberVerificationStatus | C | 0..1 | Extension(CodeableConcept) | Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatusShort description NHS number verification status Alternate namesextensions, user content DefinitionThe verification/tracing status of the NHS number. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idPatient.identifier:nhsNumber.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | S Σ ?! | 0..1 | boolean | Element idPatient.activeShort description Whether this patient's record is in active use. DefinitionWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | S Σ | 0..* | HumanName | Element idPatient.nameShort description A name associated with the patient. DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | Element idPatient.telecomShort description A contact detail for the individual. DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.system.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.system.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| otherContactSystem | C | 0..1 | Extension(CodeableConcept) | Element idPatient.telecom.system.extension:otherContactSystemShort description Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. Alternate namesextensions, user content DefinitionOther contact system value which extends the system element in the ContactPoint datatype. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.telecom.system.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | S Σ | 0..1 | codeBinding | Element idPatient.genderShort description The gender that the patient is considered to have for administration and record keeping purposes. DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | S Σ | 0..1 | date | Element idPatient.birthDateShort description The date of birth for the individual. DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthTime | C | 0..1 | Extension(dateTime) | Element idPatient.birthDate.extension:birthTimeShort description The time of day that the patient was born. This SHOULD be included when the birth time is relevant. Alternate namesextensions, user content DefinitionThe time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/StructureDefinition/patient-birthTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.extension:birthTime.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extension:birthTime.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.birthDate.extension:birthTime.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/patient-birthTimeMappings
| |||
| value[x] | 1..1 | Element idPatient.birthDate.extension:birthTime.value[x]Short description Time of day of birth. DefinitionThe time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| value | 0..1 | System.Date | There are no (further) constraints on this element Element idPatient.birthDate.valueShort description Primitive value for date DefinitionPrimitive value for date System.Date | |||
| deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x]Short description Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| deceasedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| address | S Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.addressShort description An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| addressKey | C | 0..* | Extension(Complex) | Element idPatient.address.extension:addressKeyShort description A patient's address key and type Alternate namesextensions, user content DefinitionA patient's address key and type. 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.useShort description home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General homeMappings
| ||
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General bothMappings
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.textShort description Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere Street, Erewhon 9132Mappings
| ||
| line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 137 Nowhere StreetMappings
| ||
| city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General ErewhonMappings
| ||
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General MadisonMappings
| ||
| state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.stateShort description Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 9132Mappings
| ||
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
| ||
| maritalStatus | 0..1 | CodeableConceptBinding | Element idPatient.maritalStatusShort description Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. An indicator to identify the legal marital status of a person UKCorePersonMaritalStatusCode (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x]Short description Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||||
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photoShort description Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contactShort description A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contactRank | C | 0..1 | Extension(positiveInt) | Element idPatient.contact.extension:contactRankShort description The preferred ranking or order of contact applied to a contact on a Patient's contact list. Alternate namesextensions, user content DefinitionThe preferred ranking or order of contact applied to a contact on a patient's contact list. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| copyCorrespondenceIndicator | C | 0..1 | Extension(boolean) | Element idPatient.contact.extension:copyCorrespondenceIndicatorShort description Indicates that a must be copied in to all related correspondence. Alternate namesextensions, user content DefinitionExtension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationship | 0..* | CodeableConceptBinding | Element idPatient.contact.relationshipShort description The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and a contact person for that patient. UKCorePersonRelationshipType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| name | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.nameShort description A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecomShort description A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.system.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.system.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| otherContactSystem | C | 0..1 | Extension(CodeableConcept) | Element idPatient.contact.telecom.system.extension:otherContactSystemShort description Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. Alternate namesextensions, user content DefinitionOther contact system value which extends the system element in the ContactPoint datatype. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.contact.telecom.system.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.contact.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.addressShort description Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| organization | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organizationShort description Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1, pat-1 Constraints
| ||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.periodShort description The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communicationShort description A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| proficiency | C | 0..1 | Extension(Complex) | Element idPatient.communication.extension:proficiencyShort description The patient's proficiency level of the communication method. Alternate namesextensions, user content DefinitionProficiency level of the communication. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-proficiency ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| level | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:levelShort description The proficiency level of the communication Alternate namesextensions, user content DefinitionHow well the patient can communicate this communication (good, poor, etc.). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. levelMappings
| |||
| value[x] | 1..1 | Binding | Element idPatient.communication.extension:proficiency.extension:level.value[x]Short description The proficiency level for the communication DefinitionThe proficiency level for the communication. The proficiency level for the communication. v3.LanguageAbilityProficiency (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||||
| type | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:typeShort description The proficiency type of the communication Alternate namesextensions, user content DefinitionWhat type of communication for the proficiency (spoken, written, etc.). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. typeMappings
| |||
| value[x] | 1..1 | Binding | Element idPatient.communication.extension:proficiency.extension:type.value[x]Short description The proficiency type for the communication DefinitionThe proficiency type for the communication. The proficiency type for the communication. v3.LanguageAbilityMode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.org/fhir/StructureDefinition/patient-proficiencyMappings
| |||
| value[x] | 0..0 | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 1..1 | CodeableConceptBinding | Element idPatient.communication.languageShort description A ValueSet that identifies the language used by a person. DefinitionA ValueSet that identifies the language used by a person. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A ValueSet that identifies the language used by a person.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferredShort description Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| generalPractitioner | C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitionerShort description Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Reference(Organization | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| managingOrganization | S Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganizationShort description Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.linkShort description Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| other | Σ C | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.otherShort description The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.typeShort description replaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings SHALL NOT exceed 1MB in size The type of link between this patient resource and another patient resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Patient.identifier | Patient - NHS number, Patient - Local identifier, Patient - Pedigree/Family Identifier, Fetus - Local identifier, Previous genomic report - Patient's NHS number, Previous genomic report - Patient's alternative identifier, Previous genomic report - Patient's clinical genetics number, Previous genomic report - Patient's pedigree number | PID-3 |
| Patient.extension:nhsNumberUnavailableReason | Patient - Reason for unavailable NHS number, Patient - Withheld identity reason | N/A, could use PID-32 as surrogate |
| Patient.name.prefix | Patient - Title | PID-5.5 |
| Patient.name.given | Patient - First name, Previous genomic report - Patient's first name | PID-5.2 |
| Patient.name.family | Patient - Surname, Previous genomic report - Patient's surname | PID-5.1 |
| Patient.birthDate | Patient - Date of birth, PLCM activity - Patient age at activity date, Previous genomic report - Patient's date of birth | PID-7, Age derived from the difference between PID-7 and TQ1-7 for the relevant activity |
| Patient.address | Patient - Address, Previous genomic report - Patient's address | PID-11 |
| Patient.address.postalCode | Patient - Postcode, Previous genomic report - Patient's post code | PID-11.5 |
| Patient.address.country | Patient - Country, Previous genomic report - Patient's country | PID-11.6 |
| Patient.deceasedBoolean | Patient - Life status at time of request | PID-30 |
| Patient.deceasedDateTime | Patient - Date of death | PID-29 |
| Patient.extension:EthnicCategory | Patient - Ethnicity | PID-22 |
| Patient.extension:birthSex | Patient - Sex assigned at birth | PID-8 |
| Patient.extension:patient-genderIdentity | Patient - Gender Identity | N/A - not part of the HL7v2 standard, though PID-8 or an OBX segment could be used |
| Patient.generalPractitioner | Patient - GP Practice ODS Code, Patient - GP full name, Patient - GP GMC number | PD1-4 |
| Patient.gender | Fetus - Observed sex | PID-8 |
Additional Guidance
extension:fetalStatus
Extension used for determining the life status of the fetus. SHOULD always be present for a fetal patient record to help with identification.
{
"url": "http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus",
"valueCode": "potential-for-live-birth"
}
extension:UKCore-birthSex
Extension used for recording the phenotypic sex of the patient, as recorded at birth.
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender",
"code": "M",
"display": "Male"
}
]
}
}
identifier
SHALL be present for Patients within the Genomic Order Management ecosystem. It is preferred that all patients with an NHS number have this included within the Patient resource upon submission of a test order. Patient who do not have an NHS number SHOULD have a temporary one registered/assigned with PDS.For patient records where the NHS number has been traced from PDS, the trace status SHOULD be provided within the NHS Number identifier slice.
Additional identifiers SHOULD include an appropriate naming system scheme which clearly identifies the assigner (to disambiguate the identifier from other resources where these are not nationally unique). Alternatively, the OID for local identifier MAY be used, with the 'assigner' organization explicitly referenced.
"identifier": [ { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307946", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland", "version": "2.2.0", "code": "01", "display": "Number present and verified" } ] } } ] }, { "system": "urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24", "value": "RWT14789", "assigner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RAX01" } } } ],
generalPractitioner
Where patients are registered with a General Practitioner within the UK, both the ODS code for the practice and GMP number for the practitioner SHOULD be provided, where known, as separate objects within the generalPractitioner array."generalPractitioner": [ { "identifier": { "system": "https://fhir.hl7.org.uk/Id/gmp-number", "value": "G9999999" }, "display": "Dr. Aero Smith" }, { "identifier": { "system": "https://fhir.hl7.org.uk/Id/ODS-code", "value": "AP123" }, "display": "anywhere place" } ],
link
For patient records where additional information exists elsewhere, for example, within PDS or the source system EHR, this MAY be referenced through the link field, specifying the url through which the related patient information can be accessed."link": [ { "other": { "reference": "https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9449307946" }, "type": "seealso" } ]
StructureDefinition UKCore-Practitioner
Practitioner is not expected to be sent within Test Order or other interactions with the central GMS. Instead, client systems SHOULD strive to reference practitioners via their identifier within a national coding system and display name only.
The below profile is provided for information, if referencing by identifier is intractable (though repeated issues with requester ability to reference via identifier/code SHOULD be reported to the NHS England Genomic Unit for investigation).
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | UKCore | trial-use |
| UKCorePractitioner (Practitioner) | C | Practitioner | There are no (further) constraints on this element Element idPractitionerShort description A person with a formal responsibility in the provisioning of healthcare or related services DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitioner.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitioner.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitioner.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitioner.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | S Σ | 0..* | Identifier | Element idPractitioner.identifierShort description An identifier that applies to this person in this role. DefinitionAn identifier that applies to this person in this role. Often, specific identities are assigned for the agent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idPractitioner.activeShort description Whether this practitioner's record is in active use DefinitionWhether this practitioner's record is in active use. Need to be able to mark a practitioner record as not to be used because it was created in error. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | S Σ | 0..* | HumanName | Element idPractitioner.nameShort description The name(s) associated with the practitioner. DefinitionThe name(s) associated with the practitioner. The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | Element idPractitioner.telecomShort description A contact detail for the practitioner (that apply to all roles). DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address. Need to know how to reach a practitioner independent to any roles the practitioner may have. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | Σ | 0..* | Address | There are no (further) constraints on this element Element idPractitioner.addressShort description Address(es) of the practitioner that are not role specific (typically home address) DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitioner.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idPractitioner.birthDateShort description The date on which the practitioner was born DefinitionThe date of birth for the practitioner. Needed for identification. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idPractitioner.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| qualification | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitioner.qualificationShort description Certification, licenses, or training pertaining to the provision of care DefinitionThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPractitioner.qualification.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitioner.qualification.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | 0..* | Identifier | There are no (further) constraints on this element Element idPractitioner.qualification.identifierShort description An identifier for this qualification for the practitioner DefinitionAn identifier that applies to this person's qualification in this role. Often, specific identities are assigned for the qualification. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idPractitioner.qualification.codeShort description Coded representation of the qualification DefinitionCoded representation of the qualification. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific qualification the practitioner has to provide a service. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idPractitioner.qualification.periodShort description Period during which the qualification is valid DefinitionPeriod during which the qualification is valid. Qualifications are often for a limited period of time, and can be revoked. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| issuer | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPractitioner.qualification.issuerShort description Organization that regulates and issues the qualification DefinitionOrganization that regulates and issues the qualification. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| communication | 0..* | CodeableConceptBinding | Element idPractitioner.communicationShort description A language the practitioner can use in patient communication DefinitionA language the practitioner can use in patient communication. Knowing which language a practitioner speaks can help in facilitating communication with patients. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A ValueSet that identifies the language used by a person.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Practitioner.name | Requestor - Full name, Additional contact - Full name, Patient - GP full name, Previous genomic report - Report performer full name, Previous genomic report - Original requester full name, Previous non genomic report - Report performer full name, Previous non genomic report - Original requester full name | ORC-12, PD1-4.2 and PD1-4.3, OBX-16, ORC-12 |
| Practitioner.identifier | Requestor - Professional registration number, Additional contact - Professional registration number, Patient - GP GMC number | ORC-12.1, PD1-4.1 |
| Practitioner.identifier.system, Additional contact - Professional registration number type | Requestor - Professional registration number type | ORC-12.9 |
Additional Guidance
Practitioner.identifier SHOULD contain a professional code.
Note:The SDS User Id should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database.
| FHIR identifier | OID/HL7v3 | HL7v2 ITK | Format | Description | Professional Code | Prescribing Code |
|---|---|---|---|---|---|---|
| https://fhir.hl7.org.uk/Id/gmp-number | 2.16.840.1.113883.2.1.3.2.4.16.62 | GMP | G[1234589]NNNNNN | General Medical Practitioner Code GENERAL MEDICAL PRACTITIONER PPD CODE. Formerly called GP General National Code (GNC). | Yes | No, also include DIN |
| https://fhir.hl7.org.uk/Id/gmc-number | 2.16.840.1.113883.2.1.3.2.4.16.63 | GMC | CNNNNNNN | General Medical Council Code CONSULTANT_CODE | Yes | Yes |
| https://fhir.hl7.org.uk/Id/nmc-number | NNANNNNA | Nursing and Midwifery Council Code | Yes | Yes | ||
| https://fhir.hl7.org.uk/Id/gphc-number | NNNNNNN | General Pharmaceutical Council Code | Yes | Yes | ||
| https://fhir.hl7.org.uk/Id/hcpc-number | AANNNNNN(*) | Health and Care Professional Council Code | Yes | Yes | ||
| https://fhir.hl7.org.uk/Id/din-number | NNNNNN | DOCTOR INDEX NUMBER | No | Yes | ||
| https://fhir.nhs.uk/Id/sds-user-id | 1.2.826.0.1285.0.2.0.65 | N(*) | SDS User ID | No | No | |
| https://fhir.nhs.uk/Id/gmc-reference-number | 2.16.840.1.113883.2.1.3.2.4.18.29 | NNNNNNN | GMC Reference Number | No | No | |
| https://fhir.hl7.org.uk/Id/professional-code | 1.2.826.0.1285.0.2.1.54 | A(*) | ODS/NACS Practitioner Code (retired). Included for backwards compatibility | No | No |
Format
- N = any number
- A = any alpha
StructureDefinition UKCore-PractitionerRole
PractitionerRole resources SHOULD be used where information about both a practitioner and their role within a specific organization is required, e.g. as the ServiceRequest.requestor.
References to Practitioner and Organization resources SHOULD only be made via identifier, rather than appending Practitioner and Organization resources to test order bundles. Issues with referencing via identifier SHOULD be reported to the NHS England Genomics Unit for investigation.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole | UKCore | trial-use |
| UKCorePractitionerRole (PractitionerRole) | C | PractitionerRole | There are no (further) constraints on this element Element idPractitionerRoleShort description Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitionerRole.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitionerRole.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitionerRole.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitionerRole.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitionerRole.identifierShort description Business Identifiers that are specific to a role/location DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | S Σ | 0..1 | boolean | Element idPractitionerRole.activeShort description Whether this practitioner role record is in active use. DefinitionWhether this practitioner role record is in active use. Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | S Σ C | 0..1 | Period | Element idPractitionerRole.periodShort description The period during which the practitioner is authorized to perform in these role(s). DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| practitioner | S Σ C | 0..1 | Reference(Practitioner) | Element idPractitionerRole.practitionerShort description Practitioner that is able to provide the defined services for the organization. DefinitionPractitioner that is able to provide the defined services for the organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| organization | S Σ C | 0..1 | Reference(Organization) | Element idPractitionerRole.organizationShort description Organization where the roles are available. DefinitionThe organization where the Practitioner performs the roles associated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idPractitionerRole.codeShort description Roles which this practitioner may perform DefinitionRoles which this practitioner is authorized to perform for the organization. Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specialty | S Σ | 0..* | CodeableConceptBinding | Element idPractitionerRole.specialtyShort description Specific specialty of the practitioner. DefinitionSpecific specialty of the practitioner. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific specialty associated with the agency. UKCorePracticeSettingCode (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | S Σ C | 0..* | Reference(Location) | Element idPractitionerRole.locationShort description The location(s) at which this practitioner provides care. DefinitionThe location(s) at which this practitioner provides care. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| healthcareService | C | 0..* | Reference(HealthcareService) | There are no (further) constraints on this element Element idPractitionerRole.healthcareServiceShort description The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionThe list of healthcare services that this worker provides for this role's Organization/Location(s). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | Element idPractitionerRole.telecomShort description Contact details that are specific to the role/location/service. DefinitionContact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.availableTimeShort description Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availableTime.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.availableTime.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.availableTime.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.availableTime.daysOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| allDay | 0..1 | boolean | There are no (further) constraints on this element Element idPractitionerRole.availableTime.allDayShort description Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| availableStartTime | 0..1 | time | There are no (further) constraints on this element Element idPractitionerRole.availableTime.availableStartTimeShort description Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| availableEndTime | 0..1 | time | There are no (further) constraints on this element Element idPractitionerRole.availableTime.availableEndTimeShort description Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.notAvailableShort description Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.descriptionShort description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| during | C | 0..1 | Period | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.duringShort description Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availabilityExceptionsShort description Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endpoint | C | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idPractitionerRole.endpointShort description Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
- PractitionerRole-AnnaLaneKingstonPathology-Example
- PractitionerRole-EugeneSmith-Example
- PractitionerRole-EugeneSmithLeedsSTH-Example
- PractitionerRole-GeneSmithENT-Example
- PractitionerRole-HazelSmithKingstonPathology-Example
- PractitionerRole-HazelSmithPathology-Example
- PractitionerRole-HazelSmithRenal-Example
- PractitionerRole-JamesTaylorKingstonPathology-Example
- PractitionerRole-LoisLane-Example
- PractitionerRole-LoisLaneKingstonClinicalGenetics-Example
- PractitionerRole-LucyHale-Example
- PractitionerRole-MarySmith-Example
- PractitionerRole-OscarShields-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| PractitionerRole.practitioner | Requestor - Full name, Requestor - Professional registration number, Requestor - Professional registration number type, Additional contact - Full name, Additional contact - Professional registration number, Additional contact - Professional registration number type, Patient - GP full name, Patient - GP GMC number, Previous genomic report - Report performer full name, Previous genomic report - Original requester full name, Previous non genomic report - Report performer full name, Previous non genomic report - Original requester full name | ORC-12, ORC-12.1, ORC-12.9, PD1-4.2 and PD1-4.3, PD1-4.1, OBX-16, ORC-12 |
| PractitionerRole.code | Requestor - Job Title, Additional contact - Job Title | CTD-1 |
| PractitionerRole.specialty | Requestor - Current Specialty, Requestor - Department name, Additional contact - Current Specialty, Additional contact - Department name | Additional CTD-1 segments |
| PractitionerRole.telecom | Requestor - Phone, Requestor - Email address, Requestor - Genomic report delivery method, Requestor - Central email for address and reporting (many), Additional contact - Phone, Additional contact - Email address, Additional contact - Genomic report delivery method, Additional contact - Central email for address and reporting (many) | ORC-14 |
| PractitionerRole.organization | Requestor - Organization name, Requestor - Organization address, Requestor - Organization ODS code, Additional contact - Organization name, address and ODS code, Additional contact - Organization address, Additional contact - Organization ODS code, Patient - GP Practice ODS Code, Previous genomic report - Report performer organisation ODS code, Previous genomic report - Original requester organisation ODS code, Previous non genomic report - Report performer organisation ODS code, Previous non genomic report - Original requester organisation ODS code | ORC-21, ORC-22, ORC-21.10, OBX-23.10 |
| PractitionerRole.healthcareService | PLCM activity - ODS code of the laboratory site delivering requested test, PLCM activity - Commissioned service category code | Additional CTD-1 segments |
Additional Guidance
practitioner
SHALL be present. Users SHOULD reference practitioners using an appropriate naming system as defined within the NHS England IG , this has been copied below for convenience. Display name MAY be included to aid readability and verification of included identifiers.Note: The SDS User Id is the preferred identifier naming scheme and SHOULD be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database. Where the SDS User ID cannot be obtained, or is not applicable for the healthcare worker, one of the professional codes below MAY be used.
| FHIR identifier | OID/HL7v3 | HL7v2 ITK | Format | Description | Professional Code |
|---|---|---|---|---|---|
| https://fhir.hl7.org.uk/Id/gmp-number | 2.16.840.1.113883.2.1.3.2.4.16.62 | GMP | G[1234589]NNNNNN | General Medical Practitioner Code GENERAL MEDICAL PRACTITIONER PPD CODE. Formerly called GP General National Code (GNC). | Yes |
| https://fhir.hl7.org.uk/Id/gmc-number | 2.16.840.1.113883.2.1.3.2.4.16.63 | GMC | CNNNNNNN | General Medical Council Code CONSULTANT_CODE | Yes |
| https://fhir.hl7.org.uk/Id/nmc-number | NNANNNNA | Nursing and Midwifery Council Code | Yes | ||
| https://fhir.hl7.org.uk/Id/gphc-number | NNNNNNN | General Pharmaceutical Council Code | Yes | ||
| https://fhir.hl7.org.uk/Id/hcpc-number | AANNNNNN(*) | Health and Care Professional Council Code | Yes | ||
| https://fhir.hl7.org.uk/Id/din-number | NNNNNN | DOCTOR INDEX NUMBER | No | ||
| https://fhir.nhs.uk/Id/sds-user-id | 1.2.826.0.1285.0.2.0.65 | N(*) | SDS User ID | No | |
| https://fhir.nhs.uk/Id/gmc-reference-number | 2.16.840.1.113883.2.1.3.2.4.18.29 | NNNNNNN | GMC Reference Number | No | |
| https://fhir.hl7.org.uk/Id/professional-code | 1.2.826.0.1285.0.2.1.54 | A(*) | ODS/NACS Practitioner Code (retired). Included for backwards compatibility | No |
Format
- N = any number
- A = any alpha
"practitioner": { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "9999999999" }, "display": "Dr. Gene Smith" },
organization
SHALL be present. Users SHOULD reference organizations using an ODS code. Display name MAY be included to aid readability and verification of included identifiers. Requester ODS codes SHOULD use the lowest level site code rather than trust code (most granular code available) where possible, to aid contact retrieval."organization": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RGT01" }, "display": "Addenbrooke's Hospital" },
specialty
The specialty field SHOULD be used to record department for the requesting clinician, issues with the use of this field, including issues with the [bound UK Core ValueSet](https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode) not representing certain departments SHOULD be reported to the NHS England Genomics Unit"specialty": [ { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode", "code": "120", "display": "Ear Nose and Throat" } ] } ],
telecom
The telecom field SHOULD be used to record contact details for the practitioner. For central mailboxes, e.g. those used for providing reports back to the requester, these SHOULD be marked with an appropriate 'contactpoint-comment' extension. Additionally, where are there multiple Practitioners involved in providing care, the contact details for each Practitioners for that location (or service) SHOULD be specified."telecom": [ { "system": "phone", "value": "01223586638" }, { "system": "email", "value": "gene.smith@nhs.net" }, { "system": "email", "value": "Add-tr.entsecretaries@nhs.net", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/contactpoint-comment", "valueString": "reporting" } ] } ]
StructureDefinition UKCore-Procedure
Used for detailing information on procedures the patient has had performed, to aid interpretation of Genomic test results.
Assertion of an absence of a procedure being performed SHOULD be recorded using an Observation resource, as described in Profile-UKCore-Observation
At a minimum, Procedure resources are expected to contain the status, code, subject and performedDateTime, though additional information conforming to the FHIR profile below MAY be included if relevant.
Genomic Study and Genomic Study Analysis profiles on Procedure may also be used as part of structured reporting. Mandated usage of these profiles is pending data standard discovery work to identify the items required within Genomic Test Reporting. As such, elements called out, and guidance suggested on this page, may be subject to change.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure | UKCore | trial-use |
| UKCoreProcedure (Procedure) | C | Procedure | There are no (further) constraints on this element Element idProcedureShort description An action that is being or was performed on a patient DefinitionAn action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idProcedure.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idProcedure.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idProcedure.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idProcedure.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idProcedure.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idProcedure.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idProcedure.identifierShort description External Identifiers for this procedure DefinitionBusiness identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. Allows identification of the procedure as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). 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. For example, multiple Patient and Person resource instances might share the same social insurance number. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | There are no (further) constraints on this element Element idProcedure.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idProcedure.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CarePlan | ServiceRequest) | There are no (further) constraints on this element Element idProcedure.basedOnShort description A request for this procedure Alternate namesfulfills DefinitionA reference to a resource that contains details of the request for this procedure. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| partOf | Σ C | 0..* | Reference(MedicationAdministration | Observation | Procedure) | There are no (further) constraints on this element Element idProcedure.partOfShort description Part of referenced event Alternate namescontainer DefinitionA larger event of which this particular procedure is a component or step. The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration). Reference(MedicationAdministration | Observation | Procedure) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idProcedure.statusShort description A code specifying the state of the procedure. DefinitionA code specifying the state of the procedure. Generally, this will be the in-progress or completed state. The "unknown" code is not to be used to convey other statuses. The "unknown" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code specifying the state of the procedure. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| statusReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.statusReasonShort description Reason for current status Alternate namesSuspended Reason, Cancelled Reason DefinitionCaptures the reason for the current state of the procedure. This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here. A code that identifies the reason a procedure was not performed. ProcedureNotPerformedReason(SNOMED-CT) (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.categoryShort description Classification of the procedure DefinitionA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A code that classifies a procedure for searching, sorting and display purposes. ProcedureCategoryCodes(SNOMEDCT) (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 0..1 | CodeableConceptBinding | Element idProcedure.codeShort description A code identifying the procedure performed. Alternate namestype DefinitionThe specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). 0..1 to account for primarily narrative only resources. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A code from the SNOMED Clinical Terminology UK. UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 1..1 | Reference(Group | Patient) | Element idProcedure.subjectShort description Who the procedure was performed on. Alternate namespatient DefinitionThe person, animal or group on which the procedure was performed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idProcedure.encounterShort description Encounter created as part of DefinitionThe Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performed[x] | S Σ | 0..1 | Element idProcedure.performed[x]Short description When the procedure was performed. DefinitionEstimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured. Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| performedAge | Age | There are no (further) constraints on this element Data type | ||||
| performedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| performedPeriod | Period | There are no (further) constraints on this element Data type | ||||
| performedRange | Range | There are no (further) constraints on this element Data type | ||||
| performedString | string | There are no (further) constraints on this element Data type | ||||
| recorder | Σ C | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idProcedure.recorderShort description Who recorded the procedure DefinitionIndividual who recorded the record and takes responsibility for its content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| asserter | Σ C | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idProcedure.asserterShort description Person who asserts this procedure DefinitionIndividual who is making the procedure statement. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idProcedure.performerShort description The people who performed the procedure DefinitionLimited to "real" people rather than equipment. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idProcedure.performer.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.performer.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.performer.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| function | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.performer.functionShort description Type of performance DefinitionDistinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist. Allows disambiguation of the types of involvement of different performers. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A code that identifies the role of a performer of the procedure. ProcedurePerformerRoleCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actor | Σ C | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idProcedure.performer.actorShort description The reference to the practitioner DefinitionThe practitioner who was involved in the procedure. A reference to Device supports use cases, such as pacemakers. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| onBehalfOf | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idProcedure.performer.onBehalfOfShort description Organization the device or practitioner was acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ C | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idProcedure.locationShort description Where the procedure happened DefinitionThe location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. Ties a procedure to where the records are likely kept. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.reasonCodeShort description Coded reason procedure performed DefinitionThe coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text. Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure. A code that identifies the reason a procedure is required. ProcedureReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation | Procedure) | There are no (further) constraints on this element Element idProcedure.reasonReferenceShort description The justification that the procedure was performed DefinitionThe justification of why the procedure was performed. It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure. Reference(Condition | DiagnosticReport | DocumentReference | Observation | Procedure) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idProcedure.bodySiteShort description Target body sites DefinitionDetailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension procedure-targetbodystructure. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| outcome | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.outcomeShort description The result of procedure DefinitionThe outcome of the procedure - did it resolve the reasons for the procedure being performed? If outcome contains narrative text only, it can be captured using the CodeableConcept.text. An outcome of a procedure - whether it was resolved or otherwise. ProcedureOutcomeCodes(SNOMEDCT) (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| report | C | 0..* | Reference(Composition | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idProcedure.reportShort description Any report resulting from the procedure DefinitionThis could be a histology result, pathology report, surgical report, etc. There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports. Reference(Composition | DiagnosticReport | DocumentReference) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| complication | 0..* | CodeableConceptBinding | Element idProcedure.complicationShort description Complication following the procedure DefinitionAny complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues. If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text. A code from the SNOMED Clinical Terminology UK with the expression (<404684003 |Clinical finding| OR <413350009 |Finding with explicit context| OR <272379006 |Event|). UKCoreConditionCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| complicationDetail | C | 0..* | Reference(Condition) | There are no (further) constraints on this element Element idProcedure.complicationDetailShort description A condition that is a result of the procedure DefinitionAny complications that occurred during the procedure, or in the immediate post-performance period. This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| followUp | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.followUpShort description Instructions for follow up DefinitionIf the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific follow up required for a procedure e.g. removal of sutures. ProcedureFollowUpCodes(SNOMEDCT) (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idProcedure.noteShort description Additional information about the procedure DefinitionAny other notes and comments about the procedure. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| focalDevice | 0..* | BackboneElement | There are no (further) constraints on this element Element idProcedure.focalDeviceShort description Manipulated, implanted, or removed device DefinitionA device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idProcedure.focalDevice.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.focalDevice.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.focalDevice.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| action | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idProcedure.focalDevice.actionShort description Kind of change to device DefinitionThe kind of change that happened to the device during the procedure. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A kind of change that happened to the device during the procedure. ProcedureDeviceActionCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| manipulated | C | 1..1 | Reference(Device) | There are no (further) constraints on this element Element idProcedure.focalDevice.manipulatedShort description Device that was changed DefinitionThe device that was manipulated (changed) during the procedure. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| usedReference | C | 0..* | Reference(Device | Medication | Substance) | There are no (further) constraints on this element Element idProcedure.usedReferenceShort description Items used during procedure DefinitionIdentifies medications, devices and any other substance used as part of the procedure. Used for tracking contamination, etc. For devices actually implanted or removed, use Procedure.device. Reference(Device | Medication | Substance) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| usedCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.usedCodeShort description Coded items used during the procedure DefinitionIdentifies coded items that were used as part of the procedure. For devices actually implanted or removed, use Procedure.device. Codes describing items used during a procedure. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Procedure | Patient - Had transplant, Patient - Had transfusion, Is patient on TKI therapy, Insulin treated within 6 months of diagnosis, Is on Ig replacement | Presence of OBR segment with OBR-44 code for transplant/transfusion etc. |
| Procedure.performedDateTime | Patient - Fetal gestation (to determine termination date), Patient - Transplant date, Patient - Transfusion date | OBR-7 |
| Procedure.code | Patient - Pregnancy type, Patient - Type of transplant, Patient - Type of transfusion, Neonatal hypoglycemia treatment details, Current exocrine pancreatic treatment | OBR segments with appropriate codes, OBR-44, OBR/RXA segments |
| Procedure.performedPeriod.start | Neonatal hypoglycemia treatment start date, Exocrine pancreatic treatment start date | OBR-7, RXA-3 |
| Procedure.performedPeriod.end | Neonatal hypoglycemia treatment end date | OBR-8 |
Additional Guidance
extension:genomic-study-analysis
From the Genomic Reporting IG Genomic Study profile. Reference to the Genomic Study Analysis resource, detailing the analyses performed as part of genomic test.
"extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-analysis-ext", "valueReference" : { "reference" : "Procedure/PGXGenomicStudyAnalysis" } } ],
Genomic Study Analysis extensions
From the Genomic Reporting IG Genomic Study Analysis profile. Various extensions covering the metadata related to a genomic test, e.g. regions studied, change types tested for etc. For the full list of extensions, please see the linked profile page.
Specifically the extension:device element SHOULD be used to record the software/device that generated an observation, where applicable.
Use of the profile and its extensions is pending further discovery of the data standards required for Genomic Reporting in the UK.
"extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-analysis-genome-build", "valueCodeableConcept" : { "coding" : [ { "system" : "http://loinc.org", "code" : "LA26806-2", "display" : "GRCh38" } ] } }, { "extension" : [ { "url" : "sequencing-coverage", "valueQuantity" : { "value" : 100 } } ], "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-analysis-metrics" }, { "extension" : [ { "url" : "description", "valueString" : "protein-coding and exon-splicing regions" }, { "url" : "studied", "valueCodeableConcept" : { "coding" : [ { "system" : "http://www.genenames.org", "code" : "HGNC:2621", "display" : "CYP2C19" } ] } }, { "url" : "studied", "valueCodeableConcept" : { "coding" : [ { "system" : "http://www.genenames.org", "code" : "HGNC:2623", "display" : "CYP2C9" } ] } }, { "url" : "studied", "valueCodeableConcept" : { "coding" : [ { "system" : "http://www.genenames.org", "code" : "HGNC:23663", "display" : "VKORC1" } ] } } ], "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-analysis-regions" } ],
status
Status SHALL use the codes recommended in the base Procedure resource, appropriately tagging procedures as having been completed or in-progress etc. depending on the actual status of the procedure.
"status": "completed",
code
SHALL be present. SNOMED CT coding is preferred, though alternative codings MAY be provided subject to review of the Coding system by the NHS England Genomics Unit.
For the Genomic Study profile, expected to be from the Genomic Study Type ValueSet
"code": { "coding": [ { "system": "http://snomed.info/sct", "code": "23719005", "display": "Transplantation of bone marrow" } ] },
subject
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS.
"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
performed[x]
performed SHOULD be provided wherever possible, using the appropriate data type, to aid in interpretation of Genomic test results.
"performedDateTime": "2020-01-19"
StructureDefinition Provenance
The Genomics Provenance SHOULD be provided alongside updates to controlled documents such as ServiceRequests and DiagnosticReports by integrated systems on any update operation to ensure auditability for any changes to resources.
It is not expected that updates which do not affect the clinical content of the document will need associated Provenance resources, e.g. addition of local identifiers (though for the purporses of the Genomic Order Management Alpha, all updates to ServiceRequest and DiagnosticReport resources will be expected to have accompanying Provenance resources). On material changes to controlled resources, ServiceRequest and DiagnosticReport, users SHOULD use the transaction endpoint on the server to bundle the updated resource and Provenance event into a single transaction.
The HL7 FHIR specification also provides the capability to attach a Provenance resource using a custom header parameter. Using this mechanism would allow clients to submit requests to the resource specific PUT enpoints for ServiceRequests and DiagnosticReports, while still aloowing changes to be captured within a Provenance resource using a single interaction. This mechanism will not be supported within the Genomic Order Management Alpha but will be investigated by the NHS England Genomics Unit for implementation in future phases.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Provenance | HL7 International | trial-use |
| Provenance | C | DomainResource | Element idProvenanceShort description Who, What, When for a set of resources Alternate namesHistory, Event, Activity DefinitionProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idProvenance.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idProvenance.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idProvenance.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idProvenance.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idProvenance.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idProvenance.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idProvenance.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idProvenance.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| target | Σ C | 1..* | Reference(Resource) | Element idProvenance.targetShort description Target Reference(s) (usually version specific) DefinitionThe Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurred[x] | 0..1 | Element idProvenance.occurred[x]Short description When the activity occurred DefinitionThe period during which the activity occurred. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| occurredDateTime | dateTime | Data type | ||||
| occurredPeriod | Period | Data type | ||||
| recorded | Σ | 1..1 | instant | Element idProvenance.recordedShort description When the activity was recorded / updated DefinitionThe instant of time at which the activity was recorded. This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| policy | 0..* | uri | Element idProvenance.policyShort description Policy or plan the activity was defined by DefinitionPolicy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| location | C | 0..1 | Reference(Location) | Element idProvenance.locationShort description Where the activity occurred, if relevant DefinitionWhere the activity occurred, if relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reason | 0..* | CodeableConceptBinding | Element idProvenance.reasonShort description Reason the activity is occurring DefinitionThe reason that the activity was taking place. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The reason the activity took place. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| activity | 0..1 | CodeableConceptBinding | Element idProvenance.activityShort description Activity that occurred DefinitionAn activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The activity that took place. ProvenanceActivityType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| agent | 1..* | BackboneElement | Element idProvenance.agentShort description Actor involved DefinitionAn actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idProvenance.agent.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idProvenance.agent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idProvenance.agent.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | Element idProvenance.agent.typeShort description How the agent participated DefinitionThe participation the agent had with respect to the activity. For example: author, performer, enterer, attester, etc. The type of participation that a provenance agent played with respect to the activity. ProvenanceParticipantType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| role | 0..* | CodeableConcept | Element idProvenance.agent.roleShort description What the agents role was DefinitionThe function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. For example: doctor, nurse, clerk, etc. The role that a provenance agent played with respect to the activity. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| who | Σ C | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idProvenance.agent.whoShort description Who participated DefinitionThe individual, device or organization that participated in the event. whoIdentity should be used when the agent is not a Resource type. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| onBehalfOf | C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idProvenance.agent.onBehalfOfShort description Who the agent is representing DefinitionThe individual, device, or organization for whom the change was made. onBehalfOfIdentity should be used when the agent is not a Resource type. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| entity | 0..* | BackboneElement | Element idProvenance.entityShort description An entity used in this activity DefinitionAn entity used in this activity. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idProvenance.entity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idProvenance.entity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idProvenance.entity.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| role | Σ | 1..1 | codeBinding | Element idProvenance.entity.roleShort description derivation | revision | quotation | source | removal DefinitionHow the entity was used during the activity. Note that FHIR strings SHALL NOT exceed 1MB in size How an entity was used in an activity. ProvenanceEntityRole (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| what | Σ C | 1..1 | Reference(Resource) | Element idProvenance.entity.whatShort description Identity of entity DefinitionIdentity of the Entity used. May be a logical or physical uri and maybe absolute or relative. whatIdentity should be used for entities that are not a Resource type. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| agent | 0..* | see (agent) | There are no (further) constraints on this element Element idProvenance.entity.agentShort description Entity is attributed to this agent DefinitionThe entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity. A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.
| |||
| signature | 0..* | Signature | Element idProvenance.signatureShort description Signature on target DefinitionA digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
- Provenance-NonWGSTestOrderFormCancellation-Example
- Provenance-NonWGSTestOrderFormUpdated-SolidTumor-Example
- Provenance-NonWGSTestOrderForm-FetalScenario-Example
- Provenance-ServiceRequestUpdate-Example
- Provenance-WGSTestOrderForm-DirectToLab-Example
- Provenance-WGSTestOrderForm-TrioTestingProbandFather-Example
Additional Guidance
target
SHALL be provided. This SHOULD be a reference to the resource on the central GMS system that was updated."target": [ { "reference": "ServiceRequest/ServiceRequest-SavedTestOrderUpdated-Example" } ],
recorded
SHALL be provided, the date/time when the update took place."recorded": "2023-08-10T11:10:00Z",
reason
The reason why the update took place. If the codes provided by HL7 are not granular enough, or additional notes need to be recorded detailing the reasoning behind a change, this SHOULD be added as text to 'reason.text'."reason": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason", "code": "TREAT", "display": "treatment" } ], "text": "Test inappropriate for patient" } ],
agent
SHOULD be provided where actions are user initiated. The user which performed the change, as identified through CIS2 authentication token."agent": [ { "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code": "author", "display": "Author" } ] }, "who": { "reference": "PractitionerRole/PractitionerRole-TestClinicalScientist-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "9999999997" } } } ],
signature
Signed, encrypted copy of the document, for validation that the document has not been tampered with (the requirement to include this field has not yet been validated)."signature": [ { "type": [ { "system": "urn:iso-astm:E1762-95:2013", "code": "1.2.840.10065.1.12.1.15", "display": "Addendum Signature" } ], "when": "2023-08-10T11:10:00Z", "who": { "reference": "PractitionerRole/PractitionerRole-TestClinicalScientist-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "9999999997" } }, "data": "DQo8U2lnbm...F0dXJlPg0K" } ]
StructureDefinition Questionnaire
The Genomics Questionnaire resource is used to represent the Record of Discussion Form, Consultee Declaration Form and the Young Person Assent Form. When any of these forms are sent as structured resources, they should be based upon the examples referenced by each of their names.
The Genomics Questionnaire resource is currently based on the core HL7 resource, without any need for profiling. The base R4 Questionnaire profile is provided below for completeness.
It is not expected that any Questionnaire resources will be submitted to the central service, instead the GMS solution will contain a library of Questionnaires relevant to Genomics that it can use to validate QuestionnaireReponses (such as the example Record of Discussion Questionnaire).
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Questionnaire | HL7 International | trial-use |
| Questionnaire | C | DomainResource | Element idQuestionnaireShort description A structured set of questions Alternate namesForm, CRF, Survey DefinitionA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idQuestionnaire.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idQuestionnaire.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idQuestionnaire.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 0..1 | uri | Element idQuestionnaire.urlShort description Canonical identifier for this questionnaire, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this questionnaire 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 at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idQuestionnaire.identifierShort description Additional identifier for the questionnaire DefinitionA formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | Element idQuestionnaire.versionShort description Business version of the questionnaire DefinitionThe identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire 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. There may be different questionnaire instances that have the same identifier 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 questionnaire with the format [url]|[version]. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 0..1 | string | Element idQuestionnaire.nameShort description Name for this questionnaire (computer friendly) DefinitionA natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. The cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints
| ||
| title | Σ | 0..1 | string | Element idQuestionnaire.titleShort description Name for this questionnaire (human friendly) DefinitionA short, descriptive, user-friendly title for the questionnaire. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| derivedFrom | 0..* | canonical(Questionnaire) | Element idQuestionnaire.derivedFromShort description Instantiates protocol or definition DefinitionThe URL of a Questionnaire that this Questionnaire is based on. Allows a Questionnaire to be created based on another Questionnaire. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| status | Σ ?! | 1..1 | codeBinding | Element idQuestionnaire.statusShort description draft | active | retired | unknown DefinitionThe status of this questionnaire. Enables tracking the life-cycle of the content. Allows filtering of questionnaires that are appropriate for use versus not. The lifecycle status of an artifact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| experimental | Σ | 0..1 | boolean | Element idQuestionnaire.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. Allows filtering of questionnaires that are appropriate for use versus not. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subjectType | Σ | 0..* | codeBinding | Element idQuestionnaire.subjectTypeShort description Resource that can be subject of QuestionnaireResponse DefinitionThe types of subjects that can be the subject of responses created for the questionnaire. If none are specified, then the subject is unlimited. One of the resource types defined as part of this version of FHIR. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | Σ | 0..1 | dateTime | Element idQuestionnaire.dateShort description Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the questionnaire was published. 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 questionnaire changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | Element idQuestionnaire.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the questionnaire. Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. 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 questionnaire. This item SHOULD be populated unless the information is available from context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | Element idQuestionnaire.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | 0..1 | markdown | Element idQuestionnaire.descriptionShort description Natural language description of the questionnaire DefinitionA free text natural language description of the questionnaire from a consumer's perspective. This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| useContext | Σ | 0..* | UsageContext | Element idQuestionnaire.useContextShort description The context that the content is intended to support DefinitionThe 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 questionnaire instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | Element idQuestionnaire.jurisdictionShort description Intended jurisdiction for questionnaire (if applicable) DefinitionA legal or geographic region in which the questionnaire is intended to be used. It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..1 | markdown | Element idQuestionnaire.purposeShort description Why this questionnaire is defined DefinitionExplanation of why this questionnaire is needed and why it has been designed as it has. This element does not describe the usage of the questionnaire. 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 questionnaire. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| copyright | 0..1 | markdown | Element idQuestionnaire.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| approvalDate | 0..1 | date | Element idQuestionnaire.approvalDateShort description When the questionnaire was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| lastReviewDate | 0..1 | date | Element idQuestionnaire.lastReviewDateShort description When the questionnaire was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. If specified, this date follows the original approval date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectivePeriod | Σ C | 0..1 | Period | Element idQuestionnaire.effectivePeriodShort description When the questionnaire is expected to be used DefinitionThe period during which the questionnaire content was or is planned to be in active use. Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead. The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..* | Coding | Element idQuestionnaire.codeShort description Concept that represents the overall questionnaire DefinitionAn identifier for this question or group of questions in a particular terminology such as LOINC. Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Codes for questionnaires, groups and individual questions. QuestionnaireQuestionCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| item | C | 0..* | BackboneElement | Element idQuestionnaire.itemShort description Questions and sections within the Questionnaire DefinitionA particular question, question grouping or display text that is part of the questionnaire. The content of the questionnaire is constructed from an ordered, hierarchical collection of items. The cardinality or value of this element may be affected by these constraints: ele-1, que-3 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| linkId | 1..1 | string | Element idQuestionnaire.item.linkIdShort description Unique id for item in questionnaire DefinitionAn identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| definition | 0..1 | uri | Element idQuestionnaire.item.definitionShort description ElementDefinition - details for the item DefinitionThis element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:
A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition. The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | C | 0..* | Coding | Element idQuestionnaire.item.codeShort description Corresponding concept for this item in a terminology DefinitionA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Allows linking of groups of questions to formal terminologies. The value may come from the ElementDefinition referred to by .definition. Codes for questionnaires, groups and individual questions. QuestionnaireQuestionCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-3 Constraints
| ||
| prefix | 0..1 | string | Element idQuestionnaire.item.prefixShort description E.g. "1(a)", "2.5.3" Alternate nameslabel DefinitionA short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used. These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | string | Element idQuestionnaire.item.textShort description Primary text for the item DefinitionThe name of a section, the text of a question or text content for a display item. When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | 1..1 | codeBinding | Element idQuestionnaire.item.typeShort description group | display | boolean | decimal | integer | date | dateTime + DefinitionThe type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.). Defines the format in which the user is to be prompted for the answer. Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. Distinguishes groups from questions and display text and indicates data type for questions. QuestionnaireItemType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| enableWhen | ?! C | 0..* | BackboneElement | Element idQuestionnaire.item.enableWhenShort description Only allow data when DefinitionA constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions. If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| question | 1..1 | string | Element idQuestionnaire.item.enableWhen.questionShort description Question that determines whether item is enabled DefinitionThe linkId for the question whose answer (or lack of answer) governs whether this item is enabled. If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| operator | 1..1 | codeBinding | Element idQuestionnaire.item.enableWhen.operatorShort description exists | = | != | > | < | >= | <= DefinitionSpecifies the criteria by which the question is enabled. Note that FHIR strings SHALL NOT exceed 1MB in size The criteria by which a question is enabled. QuestionnaireItemOperator (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| answer[x] | C | 1..1 | Element idQuestionnaire.item.enableWhen.answer[x]Short description Value for question comparison based on operator DefinitionA value that the referenced question is tested using the specified operator in order for the item to be enabled. Allowed values to answer questions. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-7 Constraints
| |||
| answerBoolean | boolean | Data type | ||||
| answerCoding | Coding | Data type | ||||
| answerDate | date | Data type | ||||
| answerDateTime | dateTime | Data type | ||||
| answerDecimal | decimal | Data type | ||||
| answerInteger | integer | Data type | ||||
| answerQuantity | Quantity | Data type | ||||
| answerReference | Reference(Resource) | Data type | ||||
| answerString | string | Data type | ||||
| answerTime | time | Data type | ||||
| enableBehavior | C | 0..1 | codeBinding | Element idQuestionnaire.item.enableBehaviorShort description all | any DefinitionControls how multiple enableWhen values are interpreted - whether all or any must be true. This element must be specified if more than one enableWhen value is provided. Controls how multiple enableWhen values are interpreted - whether all or any must be true. The cardinality or value of this element may be affected by these constraints: ele-1, que-12 Constraints
| ||
| required | C | 0..1 | boolean | Element idQuestionnaire.item.requiredShort description Whether the item must be included in data results DefinitionAn indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition. Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value The cardinality or value of this element may be affected by these constraints: ele-1, que-6 Constraints
| ||
| repeats | C | 0..1 | boolean | Element idQuestionnaire.item.repeatsShort description Whether the item may repeat DefinitionAn indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups. Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items. The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values. The value may come from the ElementDefinition referred to by .definition. Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value The cardinality or value of this element may be affected by these constraints: ele-1, que-6 Constraints
| ||
| readOnly | C | 0..1 | boolean | Element idQuestionnaire.item.readOnlyShort description Don't allow human editing DefinitionAn indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc. The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers. The cardinality or value of this element may be affected by these constraints: ele-1, que-9 Constraints
| ||
| maxLength | C | 0..1 | integer | Element idQuestionnaire.item.maxLengthShort description No more than this many characters DefinitionThe maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition. The cardinality or value of this element may be affected by these constraints: ele-1, que-10 Constraints
| ||
| answerValueSet | C | 0..1 | canonical(ValueSet) | Element idQuestionnaire.item.answerValueSetShort description Valueset containing permitted answers DefinitionA reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question. LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition. The cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5 Constraints
| ||
| answerOption | C | 0..* | BackboneElement | Element idQuestionnaire.item.answerOptionShort description Permitted answer DefinitionOne of the permitted answers for a "choice" or "open-choice" question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | 1..1 | Element idQuestionnaire.item.answerOption.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueCoding | Coding | Data type | ||||
| valueDate | date | Data type | ||||
| valueInteger | integer | Data type | ||||
| valueReference | Reference(Resource) | Data type | ||||
| valueString | string | Data type | ||||
| valueTime | time | Data type | ||||
| initialSelected | 0..1 | boolean | Element idQuestionnaire.item.answerOption.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Use this instead of initial[v] if answerValueSet is present. Only selected items explicitly marked to be selected The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| initial | C | 0..* | BackboneElement | Element idQuestionnaire.item.initialShort description Initial value(s) when item is first rendered DefinitionOne or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. In some workflows, having defaults saves time. The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value. The cardinality or value of this element may be affected by these constraints: ele-1, que-8, que-13 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.initial.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.initial.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.initial.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | 1..1 | Element idQuestionnaire.item.initial.value[x]Short description Actual value for initializing the question DefinitionThe actual value to for an initial answer. The type of the initial value must be consistent with the type of the item. Allowed values to answer questions. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueAttachment | Attachment | Data type | ||||
| valueBoolean | boolean | Data type | ||||
| valueCoding | Coding | Data type | ||||
| valueDate | date | Data type | ||||
| valueDateTime | dateTime | Data type | ||||
| valueDecimal | decimal | Data type | ||||
| valueInteger | integer | Data type | ||||
| valueQuantity | Quantity | Data type | ||||
| valueReference | Reference(Resource) | Data type | ||||
| valueString | string | Data type | ||||
| valueTime | time | Data type | ||||
| valueUri | uri | Data type | ||||
| item | C | 0..* | see (item) | There are no (further) constraints on this element Element idQuestionnaire.item.itemShort description Nested questionnaire items DefinitionText, questions and other groups to be nested beneath a question or group. Reports can consist of complex nested groups. There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting. The cardinality or value of this element may be affected by these constraints: que-1 Mappings
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| Questionnaire | RoD Questionnaire Schema |
StructureDefinition QuestionnaireResponse
The Genomics QuestionnaireResponse is currently based on the core HL7 resource, without any need for profiling.
The profile for QuestionnaireResponse is provided below for completeness.
No additional guidance has been provided on this page as there are no Genomic-specific considerations which need to be made. However, all QuestionnaireResponses submitted to the central service SHALL reference a Questionnaire definition in order to aid validation and presentation of the response content.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse | HL7 International | trial-use |
| QuestionnaireResponse | C | DomainResource | Element idQuestionnaireResponseShort description A structured set of questions and their answers Alternate namesForm, QuestionnaireAnswers DefinitionA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idQuestionnaireResponse.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaireResponse.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaireResponse.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idQuestionnaireResponse.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idQuestionnaireResponse.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..1 | Identifier | Element idQuestionnaireResponse.identifierShort description Unique id for this set of answers DefinitionA business identifier assigned to a particular completed (or partially completed) questionnaire. Used for tracking, registration and other business purposes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CarePlan | ServiceRequest) | Element idQuestionnaireResponse.basedOnShort description Request fulfilled by this QuestionnaireResponse Alternate namesorder DefinitionThe order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| partOf | Σ C | 0..* | Reference(Observation | Procedure) | Element idQuestionnaireResponse.partOfShort description Part of this action DefinitionA procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn. Reference(Observation | Procedure) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| questionnaire | Σ | 0..1 | canonical(Questionnaire) | Element idQuestionnaireResponse.questionnaireShort description Form being answered Alternate namesForm DefinitionThe Questionnaire that defines and organizes the questions for which answers are being provided. Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form. If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idQuestionnaireResponse.statusShort description in-progress | completed | amended | entered-in-error | stopped DefinitionThe position of the questionnaire response within its overall lifecycle. The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Lifecycle status of the questionnaire response. QuestionnaireResponseStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | Σ C | 0..1 | Reference(Resource) | Element idQuestionnaireResponse.subjectShort description The subject of the questions Alternate namesPatient, Focus DefinitionThe subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. Allows linking the answers to the individual the answers describe. May also affect access control. If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | Element idQuestionnaireResponse.encounterShort description Encounter created as part of DefinitionThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. Provides context for the information that was captured. May also affect access control. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| authored | Σ | 0..1 | dateTime | Element idQuestionnaireResponse.authoredShort description Date the answers were gathered Alternate namesDate Created, Date published, Date Issued, Date updated DefinitionThe date and/or time that this set of answers were last changed. Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers. May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author | Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idQuestionnaireResponse.authorShort description Person who received and recorded the answers Alternate namesLaboratory, Service, Practitioner, Department, Company, Performer DefinitionPerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers. Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| source | Σ C | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idQuestionnaireResponse.sourceShort description The person who answered the questions DefinitionThe person who answered the questions about the subject. When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions. If not specified, no inference can be made about who provided the data. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| item | C | 0..* | BackboneElement | Element idQuestionnaireResponse.itemShort description Groups and questions DefinitionA group or question item from the original questionnaire for which answers are provided. Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| linkId | 1..1 | string | Element idQuestionnaireResponse.item.linkIdShort description Pointer to specific item from Questionnaire DefinitionThe item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| definition | 0..1 | uri | Element idQuestionnaireResponse.item.definitionShort description ElementDefinition - details for the item DefinitionA reference to an ElementDefinition that provides the details for the item. A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition. The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | string | Element idQuestionnaireResponse.item.textShort description Name for group or question text DefinitionText that is displayed above the contents of the group or as the text of the question being answered. Allows the questionnaire response to be read without access to the questionnaire. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| answer | 0..* | BackboneElement | Element idQuestionnaireResponse.item.answerShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | 0..1 | Element idQuestionnaireResponse.item.answer.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Code indicating the response provided for a question. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueAttachment | Attachment | Data type | ||||
| valueBoolean | boolean | Data type | ||||
| valueCoding | Coding | Data type | ||||
| valueDate | date | Data type | ||||
| valueDateTime | dateTime | Data type | ||||
| valueDecimal | decimal | Data type | ||||
| valueInteger | integer | Data type | ||||
| valueQuantity | Quantity | Data type | ||||
| valueReference | Reference(Resource) | Data type | ||||
| valueString | string | Data type | ||||
| valueTime | time | Data type | ||||
| valueUri | uri | Data type | ||||
| item | 0..* | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.itemShort description Nested groups and questions DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.
| |||
| item | 0..* | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.itemShort description Nested questionnaire response items DefinitionQuestions or sub-groups nested beneath a question or group. Reports can consist of complex nested groups.
|
- QuestionnaireResponse-Genomic Testing
- QuestionnaireResponse-RoD-ConsulteeDeclarationForm-Example
- QuestionnaireResponse-RoD-Example
- QuestionnaireResponse-RoD-PheobeSmithamCDForn-Example
- QuestionnaireResponse-RoD-PheobeSmithamFather-Example
- QuestionnaireResponse-RoD-PheobeSmithamMother-Example
- QuestionnaireResponse-RoD-PheobeSmithamYPAForm-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| QuestionnaireResponse | Record of Discussion | CON segments |
| QuestionnaireResponse.item.answer | RoD questions with appropriate linkId: RoD - Patient category, Test type, RoD - Research opt out reason, RoD - Remote consent, RoD - Recording clinician, RoD - Responsible clinician, RoD - Patient choice status, RoD - Has research participation been discussed, RoD - Signature | CON (for OML, included in RoD, referenced from NTE-3) |
StructureDefinition UKCore-RelatedPerson
Used for linking Patients with relatives, both for capturing pedigree and family history as well as in the case of proband and consultand within duo and trio testing.
For instances where clinical/demographic information for the related person are required and they are not included within testing, a Patient resource for the related person SHOULD be included, with the Patient.link field referencing the RelatedPerson resource for the same individual. Elements duplicated across both the Patient and RelatedPerson for the same individual SHOULD in this case be captured within the Patient resource only. The RelatedPerson resource then references the proband Patient resource through the RelatedPerson.patient field.
For Duo/Trio scenarios, RelatedPerson resources should be added to the supportingInfo field for the Consultand request, with links from the related person following the same pattern as above.
A diagram illustrating the links between resources is provided below (Duo Scenario):
Further use cases surrounding the use of RelatedPerson are pending further Duo/Trio scenarios.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson | UKCore | trial-use |
| UKCoreRelatedPerson (RelatedPerson) | C | RelatedPerson | There are no (further) constraints on this element Element idRelatedPersonShort description A person that is related to a patient, but who is not a direct target of care DefinitionInformation about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contactPreference | C | 0..1 | Extension(Complex) | Element idRelatedPerson.extension:contactPreferenceShort description The preferred method of contact, contact times and written communication format given by a Patient or Related Person. Alternate namesextensions, user content DefinitionThe preferred method of contact, contact times and written communication format given by a Patient or Related Person. 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. Extension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| copyCorrespondenceIndicator | C | 0..1 | Extension(boolean) | Element idRelatedPerson.extension:copyCorrespondenceIndicatorShort description Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. Alternate namesextensions, user content DefinitionExtension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifierShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | S Σ ?! | 0..1 | boolean | Element idRelatedPerson.activeShort description Whether this related person's record is in active use. DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| patient | S Σ C | 1..1 | Reference(Patient) | Element idRelatedPerson.patientShort description The patient this person is related to. DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationship | S Σ | 0..* | CodeableConceptBinding | Element idRelatedPerson.relationshipShort description The nature of the relationship. DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person. UKCorePersonRelationshipType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | S Σ | 0..* | HumanName | Element idRelatedPerson.nameShort description A name associated with the person. DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | Element idRelatedPerson.telecomShort description A contact detail for the person. DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.telecom.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.telecom.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.telecom.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.telecom.system.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.telecom.system.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| otherContactSystem | C | 0..1 | Extension(CodeableConcept) | Element idRelatedPerson.telecom.system.extension:otherContactSystemShort description Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. Alternate namesextensions, user content DefinitionOther contact system value which extends the system element in the ContactPoint datatype. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idRelatedPerson.telecom.system.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.telecom.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.telecom.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idRelatedPerson.telecom.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.telecom.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDateShort description The date on which the related person was born DefinitionThe date on which the related person was born. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | S Σ | 0..* | Address | Element idRelatedPerson.addressShort description Address where the related person can be contacted or visited. DefinitionAddress where the related person can be contacted or visited. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.periodShort description Period of time that this relationship is considered valid DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idRelatedPerson.communicationShort description A language which may be used to communicate with about the patient's health DefinitionA language which may be used to communicate with about the patient's health. If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.communication.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 1..1 | CodeableConceptBinding | Element idRelatedPerson.communication.languageShort description The language which can be used to communicate with the patient about his or her health DefinitionThe ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A language which may be used to communicate with the related person about the patient's health.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.communication.preferredShort description Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| FHIR | MDS | HL7v2 |
|---|---|---|
| RelatedPerson.relationship | Patient - Relationship to proband, Previous genomic report - Patient's relationship to requesting patient | NK1-3 |
Additional Guidance
patient
SHALL be provided. This SHOULD be a reference to the Patient resource and/or the identifier, e.g. NHS number, for the patient constituting the target of the relationship. This can be visualised using the nomenclature:
{Source (identifier)} is the {Relationship type (relationship)} of {Target (patient)}
'Ryanne Boulder' is the 'natural mother' of 'Fetus of Ryanne Boulder'
In this case the fetal identifier should be used in the patient element.
"patient": { "reference": "Patient/Patient-FoetusOfRyanneBoulder-Example", "identifier": { "system": "urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24", "value": "FT-RWT13521", "assigner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RAX" } } } },
identifier
SHALL be provided. This SHOULD be NHS number or local identifier (if NHS number is unavailable e.g. for non UK residents) for the source of the relationship. This can be visualised using the nomenclature:{Source (identifier)} is the {Relationship type (relationship)} of {Target (patient)}
'Ryanne Boulder' is the 'natural mother' of 'Fetus of Ryanne Boulder'
In this case the Ryanne Boulder's identifier should be used for the RelatedPerson.identifier.
If a local identifier is used, an assigner SHALL be provided. The RelatedPerson.identifier field SHALL match the identifier used for a FamilyMemberHistory or Patient resource if these resources are about the same person.
NOTE: As a single individual MAY be related to a number of Patients the identifier used will not be unique across RelatedPerson resources. As such, both the identifier and patient elements SHOULD be used in conjunction to uniquely identify a relationship
"identifier": [ { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } ],
relationship
SHOULD use the UK Core bound ValueSet and SHOULD be present in all instances of RelatedPerson wherever possible."relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "SIS", "display": "sister" } ] } ]
StructureDefinition RequestGroup
Created and managed by the central service upon receipt of a ServiceRequest with a requisition identifier (proband requests are expected to include the extension:genomicPatientRole=Proband to identify them as the Proband request, at which point the RequestGroup will be created). Any requests submitted to the central service with the same requisition identifier will be added to the RequestGroup as additional action.resource references (it is expected that these will be consultand requests, though alternate scenarios, such as change of proband, are being investigated).
Aspects of the RequestGroup will be automatically set based on the constituent requests, e.g. propagating status based on statuses of the ServiceRequests.
It is expected the resources will likely be read-only, though needs for editing RequestGroups, e.g. due to mark-in-error/revokation scenarios, are currently being investigated.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/RequestGroup | HL7 International | trial-use |
| RequestGroup | C | DomainResource | Element idRequestGroupShort description A group of related requests DefinitionA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRequestGroup.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRequestGroup.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRequestGroup.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRequestGroup.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idRequestGroup.identifierShort description Business identifier DefinitionAllows a service to provide a unique, business identifier for the request. Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical | Element idRequestGroup.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | Element idRequestGroup.instantiatesUriShort description Instantiates external protocol or definition DefinitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | C | 0..* | Reference(Resource) | Element idRequestGroup.basedOnShort description Fulfills plan, proposal, or order Alternate namesfulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this request. Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | C | 0..* | Reference(Resource) | Element idRequestGroup.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| groupIdentifier | Σ | 0..1 | Identifier | Element idRequestGroup.groupIdentifierShort description Composite request this is part of Alternate namesgrouperid, requisition DefinitionA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idRequestGroup.statusShort description draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe current state of the request. For request groups, the status reflects the status of all the requests in the group. Note that FHIR strings SHALL NOT exceed 1MB in size Codes identifying the lifecycle stage of a request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | Σ ?! | 1..1 | codeBinding | Element idRequestGroup.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Alternate namescategory DefinitionIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. Note that FHIR strings SHALL NOT exceed 1MB in size Codes indicating the degree of authority/intentionality associated with a request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | Element idRequestGroup.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the request should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this request should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | CodeableConcept | Element idRequestGroup.codeShort description What's being requested/ordered DefinitionA code that identifies what the overall request group is. This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | C | 0..1 | Reference(Group | Patient) | Element idRequestGroup.subjectShort description Who the request group is about DefinitionThe subject for which the request group was created. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | C | 0..1 | Reference(Encounter) | Element idRequestGroup.encounterShort description Created as part of DefinitionDescribes the context of the request group, if any. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| authoredOn | 0..1 | dateTime | Element idRequestGroup.authoredOnShort description When the request group was authored DefinitionIndicates when the request group was created. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | C | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Element idRequestGroup.authorShort description Device or practitioner that authored the request group DefinitionProvides a reference to the author of the request group. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | 0..* | CodeableConcept | Element idRequestGroup.reasonCodeShort description Why the request group is needed DefinitionDescribes the reason for the request group in coded or textual form. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reasonReference | C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | Element idRequestGroup.reasonReferenceShort description Why the request group is needed DefinitionIndicates another resource whose existence justifies this request group. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | DiagnosticReport | DocumentReference | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | Element idRequestGroup.noteShort description Additional notes about the response DefinitionProvides a mechanism to communicate additional information about the response. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| action | C | 0..* | BackboneElement | Element idRequestGroup.actionShort description Proposed actions, if any DefinitionThe actions, if any, produced by the evaluation of the artifact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | 0..1 | string | Element idRequestGroup.action.prefixShort description User-visible prefix for the action (e.g. 1. or A.) DefinitionA user-visible prefix for the action. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| title | 0..1 | string | Element idRequestGroup.action.titleShort description User-visible title DefinitionThe title of the action displayed to a user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| description | Σ | 0..1 | string | Element idRequestGroup.action.descriptionShort description Short description of the action DefinitionA short description of the action used to provide a summary to display to the user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| textEquivalent | Σ | 0..1 | string | Element idRequestGroup.action.textEquivalentShort description Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system DefinitionA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | 0..1 | codeBinding | Element idRequestGroup.action.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the action should be addressed with respect to other actions. Note that FHIR strings SHALL NOT exceed 1MB in size Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | 0..* | CodeableConcept | Element idRequestGroup.action.codeShort description Code representing the meaning of the action or sub-actions DefinitionA code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| documentation | 0..* | RelatedArtifact | Element idRequestGroup.action.documentationShort description Supporting documentation for the intended performer of the action DefinitionDidactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| condition | 0..* | BackboneElement | Element idRequestGroup.action.conditionShort description Whether or not the action is applicable DefinitionAn expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.condition.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| kind | 1..1 | codeBinding | Element idRequestGroup.action.condition.kindShort description applicability | start | stop DefinitionThe kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. The kind of condition for the action. ActionConditionKind (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| expression | C | 0..1 | Expression | Element idRequestGroup.action.condition.expressionShort description Boolean-valued expression DefinitionAn expression that returns true or false, indicating whether or not the condition is satisfied. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relatedAction | 0..* | BackboneElement | Element idRequestGroup.action.relatedActionShort description Relationship to another action DefinitionA relationship to another action such as "before" or "30-60 minutes after start of". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actionId | 1..1 | id | Element idRequestGroup.action.relatedAction.actionIdShort description What action this is related to DefinitionThe element id of the action this is related to. RFC 4122 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relationship | 1..1 | codeBinding | Element idRequestGroup.action.relatedAction.relationshipShort description before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end DefinitionThe relationship of this action to the related action. Note that FHIR strings SHALL NOT exceed 1MB in size Defines the types of relationships between actions. ActionRelationshipType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| offset[x] | 0..1 | Element idRequestGroup.action.relatedAction.offset[x]Short description Time offset for the relationship DefinitionA duration or range of durations to apply to the relationship. For example, 30-60 minutes before. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| offsetDuration | Duration | Data type | ||||
| offsetRange | Range | Data type | ||||
| timing[x] | 0..1 | Element idRequestGroup.action.timing[x]Short description When the action should take place DefinitionAn optional value describing when the action should be performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| timingAge | Age | Data type | ||||
| timingDateTime | dateTime | Data type | ||||
| timingDuration | Duration | Data type | ||||
| timingPeriod | Period | Data type | ||||
| timingRange | Range | Data type | ||||
| timingTiming | Timing | Data type | ||||
| participant | C | 0..* | Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idRequestGroup.action.participantShort description Who should perform the action DefinitionThe participant that should perform or be responsible for this action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 0..1 | CodeableConceptBinding | Element idRequestGroup.action.typeShort description create | update | remove | fire-event DefinitionThe type of action to perform (create, update, remove). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of action to be performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| groupingBehavior | 0..1 | codeBinding | Element idRequestGroup.action.groupingBehaviorShort description visual-group | logical-group | sentence-group DefinitionDefines the grouping behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines organization behavior of a group. ActionGroupingBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| selectionBehavior | 0..1 | codeBinding | Element idRequestGroup.action.selectionBehaviorShort description any | all | all-or-none | exactly-one | at-most-one | one-or-more DefinitionDefines the selection behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection behavior of a group. ActionSelectionBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| requiredBehavior | 0..1 | codeBinding | Element idRequestGroup.action.requiredBehaviorShort description must | could | must-unless-documented DefinitionDefines expectations around whether an action is required. Note that FHIR strings SHALL NOT exceed 1MB in size Defines expectations around whether an action or action group is required. ActionRequiredBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| precheckBehavior | 0..1 | codeBinding | Element idRequestGroup.action.precheckBehaviorShort description yes | no DefinitionDefines whether the action should usually be preselected. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection frequency behavior for an action or group. ActionPrecheckBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| cardinalityBehavior | 0..1 | codeBinding | Element idRequestGroup.action.cardinalityBehaviorShort description single | multiple DefinitionDefines whether the action can be selected multiple times. Note that FHIR strings SHALL NOT exceed 1MB in size Defines behavior for an action or a group for how many times that item may be repeated. ActionCardinalityBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| resource | C | 0..1 | Reference(Resource) | Element idRequestGroup.action.resourceShort description The target of the action DefinitionThe resource that is the target of the action (e.g. CommunicationRequest). The target resource SHALL be a Request resource with a Request.intent set to "option". The cardinality or value of this element may be affected by these constraints: ele-1, rqg-1 Constraints
| ||
| action | C | 0..* | see (action) | There are no (further) constraints on this element Element idRequestGroup.action.actionShort description Sub action DefinitionSub actions. The cardinality or value of this element may be affected by these constraints: rqg-1 |
| FHIR | MDS | HL7v2 |
|---|
Additional Guidance
identifier
Automatically assigned by the central service, matching the ServiceRequest.requisition."identifier": [ { "system": "https://fhir.leedssth.nhs.uk//Id/grouptestId", "value": "RR-REQ12764", "assigner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } } } ],
status
Automatically assigned by the central service, status will be propagated based on the included ServiceRequests. At the point a ServiceRequest is added, either in `draft` or `active` state, the RequestGroup will be marked as `active`. If all ServiceRequests under the RequestGroup are marked as `completed` or `revoked`, this will be propagated up to the request group level.Propagation of other statuses is currently under review.
"status": "active",
subject
Automatically assigned by the central service. SHALL match the subject referenced from the Proband request."subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
action
Automatically updated by the central service upon receipt of a request with a requisition identifier. Additional requests will be added to an existing request group if they share a requisition identifier with an existing service request."action": [ { "resource": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-TrioTestingProband-Example" } }, { "resource": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-TrioTestingProbandFather-Example" } }, { "resource": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-TrioTestingProbandMother-Example" } } ]
StructureDefinition ResearchSubject
The need for a Genomics ResearchSubject is currently under review.
The profile for the international FHIR ResearchSubject is provided below for completeness.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/ResearchSubject | HL7 International | trial-use |
The CareConnect profile will be uplifted to the R4 UKCore in a future release
| ResearchSubject | C | DomainResource | Element idResearchSubjectShort description Physical entity which is the primary unit of interest in the study Alternate namesStudy Subject DefinitionA physical entity which is the primary unit of operational and/or administrative interest in a study. Need to make sure we encompass public health studies.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idResearchSubject.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idResearchSubject.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idResearchSubject.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idResearchSubject.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idResearchSubject.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idResearchSubject.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idResearchSubject.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idResearchSubject.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idResearchSubject.identifierShort description Business Identifier for research subject in a study DefinitionIdentifiers assigned to this research subject for a study. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idResearchSubject.statusShort description candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn DefinitionThe current state of the subject. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates the progression of a study subject through a study. ResearchSubjectStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | Element idResearchSubject.periodShort description Start and end of participation Alternate namestiming DefinitionThe dates the subject began and ended their participation in the study. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| study | Σ C | 1..1 | Reference(ResearchStudy) | Element idResearchSubject.studyShort description Study subject is part of DefinitionReference to the study the subject is participating in. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| individual | Σ C | 1..1 | Reference(Patient) | Element idResearchSubject.individualShort description Who is part of study DefinitionThe record of the person or animal who is involved in the study. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assignedArm | 0..1 | string | Element idResearchSubject.assignedArmShort description What path should be followed DefinitionThe name of the arm in the study the subject is expected to follow as part of this study. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| actualArm | 0..1 | string | Element idResearchSubject.actualArmShort description What path was followed DefinitionThe name of the arm in the study the subject actually followed as part of this study. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| consent | C | 0..1 | Reference(Consent) | Element idResearchSubject.consentShort description Agreement to participate in study DefinitionA record of the patient's informed agreement to participate in the study. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
StructureDefinition UKCore-ServiceRequest
Focal resource for test order messages. All additional information or resources SHOULD be linked back to the ServiceRequest or be referenced from the ServiceRequest directly.
ServiceRequests which have been updated post submission SHALL be accompanied by Provenance resources, referencing the ServiceRequest which detail when the resource was changed, who made the change and why.
Note on inheritance from prior requests
It is expected that the ServiceRequest.basedOn SHALL reference a parent request where this ServiceRequest is based a previous request, e.g. in the case of reanalysis (where prior outputs/data are used) and cascade testing (where processing of a prior request has triggered the current request), or Germline Late tests in the Tumour First/Germline Late scenario (to link tests which need to be processed together).
It is expected that the prior request should be referenced from ServiceRequest.basedOn if data or outputs from the prior request are required in order to properly interpret the current request. If a banked sample needs to be processed, e.g. in the case of a request on Stored DNA, it is expected that this would be referenced directly from ServiceRequest.specimen.
Where multiple samples are associated with a previous request, it is expected only one would be active, e.g. marked as available. Additionally, in most cases the data is required, rather than reprocessing of the sample itself, in which case referencing the previous request is sufficient. However, if there are multiple active samples associated with a previous request, and a subset of the samples need to be reprocessed, the sample(s) itself SHOULD be referenced from ServiceRequest.specimen as above. If multiple outputs, i.e. data from multiple samples, are associated with a previous request, a ServiceRequest MAY reference the data to be reinterpreted/reanalysed through ServiceRequest.supportingInfo.
An illustrative diagram of the links between ServiceRequests and other resources is provided below. Note: not all resource links are represented, to increase legibility of the diagram.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest | UKCore | trial-use |
| UKCoreServiceRequest (ServiceRequest) | C | ServiceRequest | There are no (further) constraints on this element Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idServiceRequest.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idServiceRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idServiceRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idServiceRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfServiceRequest | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:sourceOfServiceRequestShort description Describes the source of the Service Request. Alternate namesextensions, user content DefinitionThis represents the source of referral. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| additionalContact | C | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) | Element idServiceRequest.extension:additionalContactShort description Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician. Alternate namesextensions, user content DefinitionDetails of an additional contact, who should be contacted regarding questions arising from the service request. 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. Extension(Reference(Organization | Practitioner | PractitionerRole)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coverage | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:coverageShort description Supports the exchange of information describing the method of funding for the Service Request. Alternate namesextensions, user content DefinitionThe funding category for the Service Request. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. Note: This is a business identifier, not a resource identifier (see discussion). 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. For example, multiple Patient and a Person resource instance might share the same social insurance number. canonical(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | S Σ C | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest) | Element idServiceRequest.basedOnShort description What the service request fulfils. Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | MedicationRequest | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description What request replaces Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description Composite Request ID Alternate namesgrouperId, groupIdentifier DefinitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.statusShort description The status of the order. DefinitionThe status of the order. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. The status of a service order. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.intentShort description Whether the request is a proposal, plan, an original order or a reflex order. DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | S Σ | 0..* | CodeableConcept | Element idServiceRequest.categoryShort description A code that classifies the service for searching, sorting and display purposes. DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. Unordered, Open, by coding.system(Value) BindingClassification of the requested service. ServiceRequestCategoryCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.category:genomicsWholeCaseSequencingShort description Classification of Genomics service DefinitionA code that classifies the service for Genomics, whether it is a Whole Case Genome Sequencing or non-Whole Genome Sequencing for cancer or rare diseases Used for filtering what service request are retrieved and displayed. There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. Classification of the requested service. UKCoreGenomeSequencingCategory (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uriFixed Value | Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategoryMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | S Σ | 0..1 | codeBinding | Element idServiceRequest.priorityShort description Indicates how quickly the ServiceRequest should be addressed with respect to other requests. DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.priority.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.priority.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priorityReason | C | 0..* | Extension(CodeableConcept) | Element idServiceRequest.priority.extension:priorityReasonShort description Supports the underlying reason why a Service Request is urgent. Alternate namesextensions, user content DefinitionA SNOMED CT concept representing the reason a Service Request is urgent 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.priority.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description True if service/procedure should not be performed DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed. Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. If missing, the request is a positive request e.g. "do perform" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description What is being requested/ordered. Alternate namesservice requested DefinitionA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system. UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| orderDetail | Σ C | 0..* | CodeableConceptBinding | Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, prr-1 Constraints
| ||
| quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description Service amount DefinitionAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). When ordering a service the number of service items may need to be specified separately from the the service item. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| quantityRange | Range | There are no (further) constraints on this element Data type | ||||
| quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| subject | S Σ C | 1..1 | Reference(Device | Group | Location | Patient) | Element idServiceRequest.subjectShort description The individual or entity the service is ordered for. DefinitionOn whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | Location | Patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description Encounter in which the request was created Alternate namescontext DefinitionAn encounter that provides additional information about the healthcare context in which this request is made. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||||
| asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description Preconditions for service DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. SNOMEDCTMedicationAsNeededReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| authoredOn | S Σ | 0..1 | dateTime | Element idServiceRequest.authoredOnShort description The date the request was signed. Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idServiceRequest.requesterShort description Who / what is requesting the service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description Performer role Alternate namesspecialty DefinitionDesired type of performer for doing the requested service. This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..* | Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description Requested location DefinitionThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationReference | Σ C | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use A set of codes that define a reason for a service request. UKCoreServiceRequestReasonCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description Explanation/Justification for service or service DefinitionIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in Reference(Condition | DiagnosticReport | DocumentReference | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| insurance | C | 0..* | Reference(ClaimResponse | Coverage) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ClaimResponse | Coverage) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. To represent information about how the services are to be delivered use the The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimen | Σ C | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description Procedure Samples DefinitionOne or more specimens that the laboratory procedure will use. Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.bodySiteShort description Location on Body Alternate nameslocation DefinitionAnatomic location where the procedure should be performed. This is the target site. Knowing where the procedure is performed is important for tracking if multiple sites are possible. Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
- ServiceRequest-NonWGSTestOrder-VariantReinterpretation-Example
- ServiceRequest-NonWGSTestOrderForm-Cancellation-Example
- ServiceRequest-NonWGSTestOrderForm-CancerSolidTumor-Example
- ServiceRequest-NonWGSTestOrderForm-CascadeTesting-Example
- ServiceRequest-NonWGSTestOrderForm-DeceasedPatient-Example
- ServiceRequest-NonWGSTestOrderForm-Example
- ServiceRequest-NonWGSTestOrderForm-FetalScenario-Example
- ServiceRequest-NonWGSTestOrderForm-FollowupTest-Example
- ServiceRequest-NonWGSTestOrderForm-HaemOncology-Example
- ServiceRequest-NonWGSTestOrderForm-HaemOncologyUpdated-Example
- ServiceRequest-NonWGSTestOrderForm-NewFollowupTest-Example
- ServiceRequest-NonWGSTestOrderForm-OutOfCountry-Example
- ServiceRequest-NonWGSTestOrderForm-UsingStoredSample-Example
- ServiceRequest-NonWGSTestOrderFormUpdated-Cancellation-Example
- ServiceRequest-NonWGSTestOrderFormUpdated-FetalScenario-Example
- ServiceRequest-NonWGSTestOrderFormUpdated-SolidTumor-Example
- ServiceRequest-SavedTestOrder-Example
- ServiceRequest-SavedTestOrderUpdated-CascadeTesting-Example
- ServiceRequest-SavedTestOrderUpdated-Example
- ServiceRequest-SavedTestOrderWGS-Example
- ServiceRequest-TestOrderForm-StorageOfMaterial-Example
- ServiceRequest-WGSTestOrderForm-DirectToLab-Example
- ServiceRequest-WGSTestOrderForm-Example
- ServiceRequest-WGSTestOrderForm-TrioTestingProband-Example
- ServiceRequest-WGSTestOrderFormUpdated-DirectToLab-Example
- ServiceRequest-WGSTestOrderFormUpdated-TrioTesting-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| ServiceRequest.requester | Requester (more details in PractitionerRole resource mappings), PLCM activity - Commissioned service category code, Previous genomic report - Original requester full name, Previous genomic report - Original requester organisation ODS code, Previous genomic report - Original requester reason for request, Previous non genomic report - Original requester full name, Previous non genomic report - Original requester organisation ODS code, Previous non genomic report - Original requester reason for request | Various ORC/STF segments |
| ServiceRequest.extension:additionalContact | Additional Contact (more details in PractitionerRole resource mappings) | Various STF segments |
| ServiceRequest.subject | Patient (more details in Patient resource mappings), Patient - Is relative | First PID segment in OML message, relatives referenced through NK1 segments |
| ServiceRequest.identifier | Test request - Test request id, PLCM activity - NGIS referral identifier, Previous genomic report - Report lab test number | ORC-2, ORC-3 |
| ServiceRequest.extension:coverage | Test request - Payment status | IN1-15 |
| ServiceRequest.authoredOn | Test request - Date and time request sent, PLCM activity - Financial month, PLCM activity - Financial year, PLCM activity - Turnaround time (calendar days) | ORC-9 (for TAT subtracted from OBR-7) |
| ServiceRequest.priority | Test request - Is urgent | TQ1-9 |
| ServiceRequest.extension:priorityReason | Test request - Urgency reason | N/A could possibly use TQ1-10 |
| ServiceRequest.code.coding.system | Test request - Test Directory version | OBR-4.3 |
| ServiceRequest.code | Test request - CI code, Test request - CITT code, PLCM activity - Service code, PLCM activity - Point of delivery code, PLCM activity - Local point of delivery code, PLCM activity - Test method code | OBR-4 |
| ServiceRequest.orderDetail | Test request - CI code for multipurpose CITT, Test request - Type of reanalysis, Test request - DNA storage information | NTE segment attached to OBR |
| ServiceRequest.category | Test request - Reason for testing, Test request - Reason for reanalysis | Likely ORC-29 |
| ServiceRequest.supportingInfo | Test request - Detail of reason for reanalysis, Test request - Further information | NTE segments linked to OBR segment for reanalysis reason, Additional segments attached to ORC/OBR |
| ServiceRequest.occurrenceDateTime | Test request - Date report required by | OBR-8 |
| ServiceRequest.performer | PLCM activity - ODS code of organisation commissioned to deliver requested test | PRD-7 where PRD-1=RT |
| ServiceRequest.note | Raw specimen/biopsy - Sample to follow reason | NTE segment attached to ORC |
Additional Guidance
- meta
- extension:genomicPatientRole
- extension:additionalContact
- extension:coverage
- identifier
- basedOn
- requisition
- status
- intent
- category
- priority
- doNotPerform
- code
- orderDetail
- subject
- occurrence[x]
- authoredOn
- requester
- performer
meta
MAY be used to record details of the originating form, from which the ServiceRequest was populated, including form code and version (under investigation)."meta": { "tag": [ { "system": "http://epr.lth.nhs.uk/CodeSystem/forms", "code": "WGS-RareDisease-TestOrderForm", "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-GenomicTestCode-Version", "valueDecimal": "1.0" ] } ] },
extension:genomicPatientRole
Genomics specific extension to support family testing. SHALL be present on requests in Duo/Trio use cases where there is a need to differentiate a request for a Proband (which needs to be reported on), from the request for a consultand, which may not result in a report.It is expected that this will impact the Tasks spun up by the central service, though this is currently still under development.
"extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-Genomic-Patient-Role", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/patient-role-genomics", "code": "proband", "display": "Proband" } ] } },
extension:additionalContact
Extension used for recording additional personnel who should be contacted regarding questions related to a test order. This is separate from the requester or reporting address.
The additional contact SHOULD be a reference to a PractitionerRole resource wherever possible and SHALL contain contact details for the practitioner.
Additionally, where are there multiple practitioners involved in providing care who need to be listed as contacts, the contact details for each practitioner (or service) SHOULD be specified through additional additionalContact entries.
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact",
"valueReference": {
"reference": "PractitionerRole/PractitionerRole-AdditionalContact-Example"
}
},
extension:coverage
SHALL be present for Genomic Order Management test orders. Extension for recording how work against the test order is being funded. The ValueSet bound to this extension is currently under review by the NHS England Genomics Informatics Working Advisory Group and subject to change.
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage",
"valueCoding": {
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-FundingCategory",
"code": "nhs",
"display": "NHS"
}
}
identifier
Automatically assigned by the central service, though source systems MAY provide a local identifier for tracking within their own system, in which case the central order number is appended to the identifiers array.
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/GMSOrder",
"value": "ROA43728"
}
],
basedOn
SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis (where prior outputs/data are used) and cascade testing (where processing of a prior request has triggered the current request), or Germline Late tests in the Tumour First/Germline Late scenario (to link tests which need to be processed together).It is expected that the prior request should be referenced from ServiceRequest.basedOn if data or outputs from the prior request are required in order to properly interpret the current request. If a banked sample needs to be processed, e.g. in the case of a request on Stored DNA, it is expected that this would be referenced directly from ServiceRequest.specimen.
Where multiple samples are associated with a previous request, it is expected only one would be active, e.g. marked as available. Additionally, in most cases the data is required, rather than reprocessing of the sample itself, in which case referencing the previous request is sufficient. However, if there are multiple active samples associated with a previous request, and a subset of the samples need to be reprocessed, the sample(s) itself SHOULD be referenced from ServiceRequest.specimen as above. If multiple outputs, i.e. data from multiple samples, are associated with a previous request, a ServiceRequest MAY reference the data to be reinterpreted/reanalysed through ServiceRequest.supportingInfo.
"basedOn": [ { "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-FatherOfFayMutlow-Example" } ],
requisition
SHALL be added for Duo/Trio requests in order to link tests together. Requisition Identifiers are used to generate RequstGroup resources that assist with management of linked requests."requisition": { "system": "https://fhir.leedssth.nhs.uk//Id/grouptestId", "value": "RR-REQ12764", "assigner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } } },
status
SHALL be provided. ServiceRequests SHOULD be marked as `draft` until ready to be acted upon, after which the user should mark the ServiceRequest as `active`.A ServiceRequest with the status of draft is assumed to be incomplete, i.e. missing information required for further processing. As such, a central order management broker SHOULD refrain from adding Tasks for the ServiceRequest until it is marked as active, at which time the necessary Tasks are spun up automatically by the broker (this is to be tested within the Genomic Order Management beta). Keeping a ServiceRequest in the draft state allows other parties to populate additional data required, such as phenotypic information from a dedicated service, or further information via a web portal. It is expected that draft ServiceRequests will be purged from the system after a period of inactivity with appropriate warnings (yet to be determined) to avoid stale orders from obscuring live tests/results.
A ServiceRequest may be marked as 'on-hold' if work against it cannot continue temporarily, e.g. due to certain prerequisite information not being provided. A ServiceRequest SHOULD be marked as 'revoked' if cancelled, either by the lab performing work against the order or at the request of the requesting clinician, though in each case a Provenance resource SHALL be provided to capture why the state change has occurred. The requesting clinician may also mark the ServiceRequest as entered-in-error, though implications for work already in progress needs to be investigated further.
A ServiceRequest SHOULD only be marked as completed by the requesting clinician upon receipt and review of the resulting DiagnosticReport.
For the full list of expected/supported ServiceRequest statuses, please see the table below:
| Status | Description | Genomic workflow usage |
|---|---|---|
| Draft | The request has been created but is not yet complete or ready for action. | Saved but not submitted to central service (out of scope for Alpha). |
| Active | The request is in force and ready to be acted upon. | Submitted to central service. |
| On Hold | The request (and any implicit authorization to act) has been temporarily withdrawn but is expected to resume in the future. | Issue with the authorization for the test (potentially recoverable), not expected to be driven by on-hold statuses of Tasks. |
| Revoked | The request (and any implicit authorization to act) has been terminated prior to the known full completion of the intended actions. No further activity should occur. | Unrecoverable issue with order. Either used when the test is no longer needed or there is an is an unrecoverable failure with its fulfillment (driven by the requesting clinician). This status will propagate down to any Tasks which have not already moved into in-progress, Tasks not started will be marked with the status of cancelled. |
| Completed | The activity described by the request has been fully performed. No further activity will occur. | Completed order, marked by requestor once DiagnosticReport is received and accepted. |
| Entered in Error | This request should never have existed and should be considered 'void'. (It is possible that real-world decisions were based on it. If real-world activity has occurred, the status should be "revoked" rather than "entered-in-error".) | MAY be used for ServiceRequests created in error, can only be set if no Tasks have been started. If a Task has been moved out of its initial state, the status of Revoked SHOULD be used instead. This status will propagate down to Tasks, marking the tasks as entered-in-error. |
| Unknown | The authoring/source system does not know which of the status values currently applies for this request. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. | Should not be used. |
For the Genomic Order Management Service central broker, in some instances the ServiceRequest.status value is cascaded down to Tasks which are generated to fulfill that request.
The list of automated state transitions from ServiceRequests to all Tasks pointing to the ServiceRequest via Task.focus are provided in the table below:
| ServiceRequest.status | Task.status | Note |
|---|---|---|
| active | requested | Not implemented within alpha, however it is expected the transition of a ServiceRequest from draft to active will allow Tasks to be spun up with a default state of requested |
| revoked | cancelled | Only tasks which have not moved to in-progress or subsequent stages can be automatically marked as cancelled, as these Tasks will require the owners to perform sone form of closure activities upon revokation of a request |
| entered-in-error | entered-in-error | This status transition is only permissible if none of the Tasks have moved into in-progress or their subsequent states, if this is the case, the ServiceRequest will need to be marked as revoked instead |
| on-hold | on-hold | TBC Not implemented within the alpha but Tasks may be automatically moved to on-hold of the focal request is marked as on-hold, to stop unneccessary processing/work against tasks |
| completed | completed | TBC Not implemented within the alpha but Tasks may be automatically moved to completed if the focal request is marked as completed, to reduce orphaned Tasks |
It is not expected that Task statuses will propagate up to the ServiceRequest status, though certain task failure types may require revokation of the authorising request (pending investigation).
"status": "active",
intent
SHALL be provided. ServiceRequests SHOULD be marked as 'order' unless they have been raised by a lab in response to an existing ServiceRequest, in which case they SHOULD be marked as 'reflex-order'. For reflex orders, the ServiceRequest.basedOn field SHALL be populated with the original ServiceRequest, for traceability."intent": "order",
category
ServiceRequests SHOULD use the Genomics Sequencing Category ValueSet when categorising the test order in order to aid analytics (e.g. PLCM). This list is pending review from the Informatics Working Advisory Group, after which a full list of possible categorisations will be finalised.
Category SHOULD additionally be populated with the type of request being ordered e.g. Diagnostic, Carrier, Predictive, Stored DNA etc. The final list of applicable codes which can be selected is still under review, the Genomic-Reason-for-Testing CodeSystem SHOULD be used for this categorisation.
"category": [ { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory", "code": "rare-disease-non-wgs", "display": "Rare Disease - Non-WGS" } ] }, { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/reasonfortesting-genomics", "code": "diagnostic", "display": "Diagnostic" } ] } ],
priority
ServiceRequests marked as urgent (i.e. not routine) SHOULD populate the extension:priorityReason with why an urgent test is being requested. This SHOULD ideally be coded using SNOMED CT concepts. Multiple priorityReason extensions are allowed within a single ServiceRequest in order to aid post-coordination."priority": "urgent", "_priority": { "extension" : [ { "url" : "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason", "valueCodeableConcept" : { "coding": [ { "system": "http://snomed.info/sct", "code": "722480002", "display": "Chemotherapy started" } ] } } ] }
doNotPerform
For the purposes of Genomic Test Ordering, the doNotPerform field SHALL NOT be used. All ServiceRequests requests received by the system will be assumed to be orders for services/testing.code
SHALL be provided. Code SHOULD contain the CI or CITT Test Directory code, currently available at https://www.england.nhs.uk/publication/national-genomic-test-directories/. There is currently no CodeSystem or queryable API for retrieving codes but work to address this is underway within the NHS England Genomics Unit.Codes from the Genomic Test Directory SHOULD also specify the version number of the test directory at the time the test is being ordered, to ensure the test methods used are consistent with that version of the directory.
"code": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory", "code": "R67.2", "display": "Monogenic hearing loss", "version": "7" } ] },
orderDetail
If multiple codes are being requested within one Test Order, these SHOULD be represented using the 'orderDetail' field, with the main indication captured using the 'code' field above. If completely separate pathways/samples etc. are required for processing against the codes, it is expected these would be requested via multiple ServiceRequests instead of a single ServiceRequest with multiple orderDetail codes. The exact cut-off for when orderDetail vs. multiple ServiceRequest should be used is still being investigated. An appropriate code(Panel codes) SHOULD come from the following NamingSystem: England-GenomicTestPanelCodeExtension-GenomicTestCode-Version:
The DGTS (Genomic Test Services) and PanelApp both maintain release versions and individual test code versions. The Extension-GenomicTestCode-Version has been provided to record specific test code version number, as shown in the snippet below:
"orderDetail": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/England-GenomicTestPanelCode", "code": "R67.1", "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-GenomicTestCode-Version", "valueDecimal": 1 } ], "display": "Monogenic hearing loss", "version": "7" } ] } ],
subject
SHALL be provided. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
occurrence[x]
If a result is required by a specific date, this MAY be indicated though occurrenceDateTime, though there is no guarantee from the GMS that the ServiceRequest will be processed in the time frame specified."occurrenceDateTime": "2023-08-25",
authoredOn
SHALL be populated by the client upon submission, either manually by the user or automatically by the system integrating with the central GMS."authoredOn": "2023-08-05",
requester
SHALL be populated on all ServiceRequests submitted to the central GMS. This SHALL reference a PractitionerRole resource also submitted to the system (either within a single transaction or previously POSTed)."requester": { "reference": "PractitionerRole/PractitionerRole-GeneSmithENT-Example" },
performer
Allows a requester to assign processing of the ServiceRequest to a particular organization (e.g. a remote GLH). The performer field SHOULD be populated with the ODS code for the managing organization/GLH.In the future state, ServiceRequests may be kept open, by not specifying a performer, allowing them to be picked up by the local GLH or otherwise routed based on by test routing (TBC).
"performer": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RGT01" } } ]
reasonReference
Reference SHOULD be associated to the primary condition being tested for. i.e,"reasonReference": { "reference": "Condition/Condition-LungTumor-Example" },
supportingInfo
Any clinical information provided about the patient for whom the testing is being requested SHALL be referenced though the supportingInfo field, to ensure all the information relevant to the ServiceRequest can be easily retrieved. This includes Observations, Conditions, Procedures, FamilyMemberHistories etc.This also includes resources related to family members included as part of testing (consultands), e.g. in Duo/Trio scenarios. In this instance, RelatedPerson and Patient resource references for the consultands SHALL be added to the supportingInfo array, as well as any clinical resources related to these individuals. This is to ensure the number of participants for a given test can be calculated correctly, e.g. through counting the number of RelatedPerson resources referenced from ServiceRequest.supportingInfo plus the subject of the ServiceRequest itself (the proband).
For WGS testing, where Records of Discussion are required in order to process the test, Consent resources SHOULD also be added to the supportingInfo array once available.
"supportingInfo": [ { "reference": "Observation/Observation-DiseaseStatus-Example" }, { "reference": "Observation/Observation-GenomicEthnicity-Example" }, { "reference": "Observation/Observation-NoPregnancy-Example" }, { "reference": "FamilyMemberHistory/FamilyMemberHistory-NonConsanguinousUnion-Example" }, { "reference": "Observation/Observation-NoTransplant-Example" }, { "reference": "Observation/Observation-NoTransfusion-Example" }, { "reference": "Condition/Condition-HearingLoss-Example" }, { "reference": "RelatedPerson/RelatedPerson-AliceSmithamProbandMother-Example" }, { "reference": "Patient/Patient-PheobeSmithamMother-Example" }, ],
specimen
ServiceRequests where the required samples already exist, e.g. in the case where a specimen already in storage needs to be processed, SHOULD reference these samples through the ServiceRequest.specimen field. Where samples need to be collected to support testing, these SHOULD instead reference the ServiceRequest, through Specimen.request (i.e. the service request has prompted collection of the sample), and these Specimen resources do not need to be referenced from within ServiceRequest.supportingInfo. The referenced Specimen resources SHOULD either be contained within the test order transaction bundle or already exist on the central GMS.In the case of Reanalysis or Reinterpretation tests, Specimens related to previous ServiceRequest are not required to be added to the new test request. The links from the previous ServiceRequest can be followed to identify the Specimens that resulted in the data being reanalysed, e.g. (reanalysis) ServiceRequest.basedOn -> (prior) ServiceRequest, (prior) ServiceRequest <- (original) Specimen.request
"specimen": [ { "reference": "Specimen/Specimen-BloodSerum-Example" } ],
note
Any information which cannot be readily be structured SHOULD be entered into the note field, though prolific use of the field to capture clinical information which better fits in level 3/4 FHIR resources is discouraged.To support disambiguation of notes originating from different fields in a client system, the AnnotationType extension MAY be used, specifying the UI element name in text (coded elements for the full list of free text UI elements expected within Test Order forms is pending finalisation and addition to the Genomic Order Management MDS). The author element MAY also be used to reference a Practitioner, by identifier or name (string), indicating the person who created the note.
"note": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/annotationType", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/mds-questiontag-genomics", "code": "TR-11", "display": "Test request - Count of related individuals to be tested" } ] } } ], "authorReference": { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "9999999999" }, "display": "Dr. Gene Smith" }, "text": "3" } ]
StructureDefinition UKCore-Specimen
Used to capture information on Samples which will undergo or have undergone processing for genomic testing.
Within FHIR R4, there is no way to capture location against a sample to aid tracking, one of the key requirements of the Genomic Medicine Service. Investigation of a possible solution through backporting the container.location element within R5 is currently being investigated. Until this backport is adopted by UK Core, the location of samples, including interactions to manage and track samples, will be performed through changes to Task resources generated on submission of a ServiceRequest.
A diagram illustrating the links between resources is provided below (Duo Scenario)
Note: links from ServiceRequest.supportingInfo to samples collected after submission are pending further investigation
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen | UKCore | trial-use |
| UKCoreSpecimen (Specimen) | C | Specimen | There are no (further) constraints on this element Element idSpecimenShort description Sample for analysis DefinitionA sample to be used for analysis.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSpecimen.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idSpecimen.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idSpecimen.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sampleCategory | C | 0..1 | Extension(CodeableConcept) | Element idSpecimen.extension:sampleCategoryShort description An extension to record the category of a sample. Alternate namesextensions, user content DefinitionThis extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.identifierShort description External Identifier DefinitionId for specimen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| accessionIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idSpecimen.accessionIdentifierShort description Identifier assigned by the lab DefinitionThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 0..1 | codeBinding | Element idSpecimen.statusShort description The availability of the specimen sample. DefinitionThe availability of the specimen. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status/availability of a specimen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | S Σ | 0..1 | CodeableConceptBinding | Element idSpecimen.typeShort description The kind of material that forms the specimen. DefinitionThe kind of material that forms the specimen. The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems. A code from the SNOMED CT UK Clinical Terminology coding system UKCoreSpecimenType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | S Σ C | 0..1 | Reference(Device | Group | Location | Patient | Substance) | Element idSpecimen.subjectShort description Where the specimen came from. DefinitionWhere the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device. Must know the subject context. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | Location | Patient | Substance) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| receivedTime | S Σ | 0..1 | dateTime | Element idSpecimen.receivedTimeShort description The time when specimen was received for processing. DefinitionTime when specimen was received for processing or testing. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| parent | C | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idSpecimen.parentShort description Specimen from which this specimen originated DefinitionReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| request | C | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idSpecimen.requestShort description Why the specimen was collected DefinitionDetails concerning a service request that required a specimen to be collected. The request may be explicit or implied such with a ServiceRequest that requires a blood draw. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| collection | C | 0..1 | BackboneElement | Element idSpecimen.collectionShort description Collection details DefinitionDetails concerning the specimen collection. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specialHandling | C | 0..* | Extension(CodeableConcept) | Element idSpecimen.collection.extension:specialHandlingShort description This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. Alternate namesextensions, user content DefinitionSpecial handling during the collection, transport, or storage of the specimen. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/StructureDefinition/specimen-specialHandling ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| collectorR5 | C | 0..1 | Extension(Reference(Patient | RelatedPerson)) | Element idSpecimen.collection.extension:collectorR5Short description Person who collected the specimen. Alternate namesextensions, user content DefinitionPerson who collected the specimen. If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 Extension(Reference(Patient | RelatedPerson)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| collector | Σ C | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idSpecimen.collection.collectorShort description Who collected the specimen DefinitionPerson who collected the specimen. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| collected[x] | Σ | 0..1 | There are no (further) constraints on this element Element idSpecimen.collection.collected[x]Short description Collection time DefinitionTime when specimen was collected from subject - the physiologically relevant time. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| collectedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| collectedPeriod | Period | There are no (further) constraints on this element Data type | ||||
| duration | Σ C | 0..1 | Duration | There are no (further) constraints on this element Element idSpecimen.collection.durationShort description How long it took to collect specimen DefinitionThe span of time over which the collection of a specimen occurred. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| quantity | C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.collection.quantityShort description The quantity of specimen collected DefinitionThe quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.collection.methodShort description Technique used to perform collection DefinitionA coded value specifying the technique that is used to perform the procedure. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The technique that is used to perform the procedure. FHIRSpecimenCollectionMethod (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| bodySite | 0..1 | CodeableConceptBinding | Element idSpecimen.collection.bodySiteShort description Anatomical collection site DefinitionAnatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension bodySite. Codes describing anatomical locations. May include laterality. UKCoreSpecimenBodySite (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySiteReference | C | 0..1 | Extension(Reference(BodyStructure)) | Element idSpecimen.collection.bodySite.extension:bodySiteReferenceShort description An extension to allow referencing to a BodyStructure. Alternate namesextensions, user content DefinitionAn extension to replicate the changes within R5 altering the data type of Specimen.collection.bodySite from CodeableConcept to CodeableReference (bodyStructure). 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. Extension(Reference(BodyStructure)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReferenceMappings
| |||
| value[x] | 1..1 | Element idSpecimen.collection.bodySite.extension:bodySiteReference.value[x]Short description A reference to a BodyStructure DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueReference | Reference(BodyStructure) | There are no (further) constraints on this element Data type | ||||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| fastingStatus[x] | Σ | 0..1 | Binding | There are no (further) constraints on this element Element idSpecimen.collection.fastingStatus[x]Short description Whether or how long patient abstained from food and/or drink DefinitionAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. Many diagnostic tests require fasting to facilitate accurate interpretation. Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation Codes describing the fasting status of the patient. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| fastingStatusCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| fastingStatusDuration | Duration | There are no (further) constraints on this element Data type | ||||
| processing | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.processingShort description Processing and processing step details DefinitionDetails concerning processing and processing steps for the specimen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.descriptionShort description Textual description of procedure DefinitionTextual description of procedure. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| procedure | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.processing.procedureShort description Indicates the treatment step applied to the specimen DefinitionA coded value specifying the procedure used to process the specimen. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Type indicating the technique used to process the specimen. SpecimenProcessingProcedure (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| additive | C | 0..* | Reference(Substance) | There are no (further) constraints on this element Element idSpecimen.processing.additiveShort description Material used in the processing step DefinitionMaterial used in the processing step. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| time[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.processing.time[x]Short description Date and time of specimen processing DefinitionA record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| timeDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| timePeriod | Period | There are no (further) constraints on this element Data type | ||||
| container | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.containerShort description Direct container of specimen (tube/slide, etc.) DefinitionThe container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| deviceR5 | C | 0..1 | Extension(Reference(Device)) | Element idSpecimen.container.extension:deviceR5Short description Device resource for the container. Alternate namesextensions, user content DefinitionThe device resource for the the container holding the specimen. If the container is in a holder then the referenced device will point to a parent device. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationR5 | C | 0..1 | Extension(Reference(UKCoreLocation)) | Element idSpecimen.container.extension:locationR5Short description Where the container is. Alternate namesextensions, user content DefinitionThe location of the container holding the specimen. 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. Extension(Reference(UKCoreLocation)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.container.identifierShort description Id for the container DefinitionId for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.descriptionShort description Textual description of the container DefinitionTextual description of the container. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | 0..1 | CodeableConceptBinding | Element idSpecimen.container.typeShort description Kind of container directly associated with specimen DefinitionThe type of container associated with the specimen (e.g. slide, aliquot, etc.). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Type of specimen container. SpecimenContainerType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| capacity | C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.capacityShort description Container volume or size DefinitionThe capacity (volume or other measure) the container may contain. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimenQuantity | C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.specimenQuantityShort description Quantity of specimen within container DefinitionThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| additive[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.container.additive[x]Short description Additive associated with container DefinitionIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Substance added to specimen container. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| additiveCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| additiveReference | Reference(Substance) | There are no (further) constraints on this element Data type | ||||
| condition | Σ | 0..* | CodeableConceptBinding | Element idSpecimen.conditionShort description State of the specimen DefinitionA mode or state of being that describes the nature of the specimen. The specimen condition can be used to assess its quality or appropriateness for a specific test. Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test. Codes describing the state of the specimen. UKCoreSampleState (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idSpecimen.noteShort description Comments DefinitionTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
- Specimen-BloodEDTA-Example
- Specimen-BloodEDTA-WithCollectionDetails-Example
- Specimen-BoneMarrowAspiration-Example
- Specimen-JamesMetcalfeBloodEDTA-Example
- Specimen-PheobeSmitham-Example
- Specimen-PheobeSmithamFather-Example
- Specimen-PheobeSmithamMother-Example
- Specimen-RyanneBoulderPartnerSaliva-Example
- Specimen-RyanneBoulderSaliva-Example
- Specimen-SolidTumor-Example
- Specimen-TissueResection-Example
- Specimen-MichealJonesBlood-Minimal
- Specimen-MichaelJonesBloodWithCollectionDetails-Example
| FHIR | MDS | HL7v2 |
|---|---|---|
| Specimen | Sample/Biopsy inc germline, Extracted Specimen | SPM |
| Specimen.subject | Fetus - Is sample for fetal or unregistered neonate, Raw specimen/biopsy - Family member provided by | PID segment attached to SPM |
| Specimen.collection.quantity | PLCM activity - Sample volume, Raw specimen/biopsy - Volume | SPM-12 |
| Specimen.type | PLCM activity - Sample category code | SPM-4 |
| Specimen.identifier.assigner | Raw specimen/biopsy - Id assigning authority ODS code (many), Raw specimen/biopsy - Is assigning authority a histopathology laboratory (many), Extracted specimen - Id assigning authority ODS code (many) | SPM-2.1.2 |
| Specimen.identifier.value | Raw specimen/biopsy - Id (many), Extracted specimen - Id (many) | SPM-2 |
| Specimen.container.identifier | Raw specimen/biopsy - Sample well identifier | SAC-3 |
| Specimen.note | Raw specimen/biopsy - Location details (will use backported R5 container.location once released), Extracted specimen - Location details, Raw specimen/biopsy - Sample to follow reason, Raw specimen/biopsy - Additional specimen/biopsy information, Extracted specimen - Additional specimen information | SAC-15, NTE segment attached to ORC, OBX segments attached to SPM |
| Specimen.extension:sampleCategory | Raw specimen/biopsy - WGS specimen type category | SPM-5 |
| Specimen.type | Raw specimen/biopsy - Type, Raw specimen/biopsy - Blood component, Extracted specimen - Type | SPM-4 |
| Specimen.condition | Raw specimen/biopsy - State | SPM-24 |
| Specimen.processing | Raw specimen/biopsy - Sample preparation (submitted to GLH) | Combination of SPM-6/SPM-24 or NTE segments if other processing |
| Specimen.collection.collectedDateTime | Raw specimen/biopsy - Obtained date | SPM-17 |
| Specimen.receivedTime | Raw specimen/biopsy - Received date | SPM-18 |
| Specimen.collection.extension:specimen-specialHandling.valueCoding.code | Raw specimen/biopsy - High risk reason, Raw specimen/biopsy - Option for products of conception | SPM-16.2, SPM-15 |
| Specimen.collection.bodySite | Raw specimen/biopsy - Biopsy site | SPM-8/SPM-9 |
| Specimen.status | Raw specimen/biopsy - Sample to follow | N/A implied through absence of SPM segment in test order |
| Specimen.condition | Extracted specimen - State | SPM-24 |
| Specimen.processing.timeDateTime | Extracted specimen - Extracted date | OBR-7 attached to processing procedure in SAC-30 |
Additional Guidance
- extension:sampleCategory
- identifier
- status
- type
- subject
- receivedTime
- parent
- request
- collection
- processing
- container
- condition
extension:sampleCategory
Allows the categorisation of a sample into either tumour or germline. Only required for WGS Cancer Testing, not currently part of the Order Management MDS. Additional terms may be added upon review though the valueCodeableConcept.text field MAY be used as a free text representation if needed."extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-SampleCategory", "code": "germline", "display": "Germline" } ] } } ]
identifier
Multiple identifiers MAY be assigned to a sample as it travels between labs. Each lab SHOULD append their local identifier to the identifier array if needed, ensuring either the system or assigner, is able to disambiguate any identifiers from possibly overlapping numbers from other organizations. Assigner is preferred in this case (see identifier example on the UKCore-Patient page for further guidance)Note: accessionIdentifier is unused by the Genomic Medicine Service to facilitate movement of samples across organizational boundaries.
"identifier": [ { "system": "https://fhir.add.nhs.uk/Id/specimenId", "value": "RGT03135" } ],
status
If a Specimen has not been collected, the status SHOULD be marked as 'unavailable'. If the quality of the Specimen is such that it cannot be processed, the status SHOULD be 'unsatisfactory' (this is equivalent to a QC status of Failed). If the Specimen passes quality control, the status SHOULD be set as 'available"status": "unsatisfactory",
type
The sample type, SNOMED CT preferred. Used to differentiate between raw and extracted (DNA) samples.ConceptMaps for the allowed values for primary (raw) and final (extracted DNA) samples upon release of MDSv1.04, to aid identification of whether a sample is primary vs. final
"type": { "coding": [ { "system": "http://snomed.info/sct", "code": "445295009", "display": "Blood specimen with EDTA" } ] },
subject
SHALL be provided. This SHOULD be a reference to the Patient resource or the identifier, NHS number, for the patient.Samples collected from a Fetus SHOULD reference a Patient resource for the Fetus. This should then be linked to relevant maternal/paternal resources through the RelatedPerson resource. Further information can be found on the Fetus Management clinical scenario. It is not envisaged that samples would need to be linked to more than one person e.g. both fetus and mother, though this assumption will be tested within the Alpha phase of the Genomic Medicine Service.
"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
receivedTime
SHOULD be updated upon receipt at a destination lab"receivedTime": "2023-09-18T18:30:00Z"
parent
If a sample has been split into multiple parts, such as DNA being extracted from a primary sample, each SHOULD be represented using an additional Specimen resource, referencing the parent sample through the parent element.The central Order Management broker will only create Tasks for Specimen resources which do not have a parent element, i.e. primary samples. If required, clients can create Tasks for processing of derivative samples manually.
MAY also be used to record the Block identifier for FFPE/Tissue samples, using the reference.identifier element, where a reference to a Specimen resource is not required.
"parent": [ { "reference": "Specimen/Specimen-BloodEDTA-Example" } ],
request
SHALL be provided. This SHOULD be a reference to the request which initiated collection of the sample. SHALL NOT be updated if the sample is used for another test e.g. for re-analysis. In the case that a Specimen needs to be processed as part of a new request, e.g. using a sample in storage, the ServiceRequest SHALL reference the pre-existing sample via ServiceRequest.specimen."request": [ { "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-Example" } ]
collection
Additional information which can be collected about the circumstances under which as sample was collected, if relevant. This include extensions for specialHandling of the sample, e.g. due to high risk of infection, as well as an extension to bodySite to extend the coding to a BodyStructure reference, for more detailed collection of structural information e.g. where tumour morphology and topography need to be collected.Where the collector is an Organization, or where the individual is not known, ODS codes MAY be used as identifiers in place of SDS-User-IDs. However, if referencing a resource, the PractitionerRole resource SHOULD still be referenced. In this case the PractitionerRole.identifier and PractitionerRole.practitioner reference would not be filled, leaving only the reference to an Organization from PractitionerRole.organization.
Note on quanitities
The Specimen.collection.quantity is the amount of the sample collected at collection time. This quantity does not change as the sample is processed.
The Specimen.container.specimenQuantity is the amount of sample remaining in a container, this is equivalent to GEL 1001 banked volume. This value should be updated as the specimen is used.
If a specimen is split, additional specimen resources SHOULD be created (referencing the parent specimen), with individual container.specimenQuantity values.
"collection": { "collector": { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "999999" } }, "collectedDateTime": "2022-07-11T09:00:00Z", "quantity": { "system": "http://unitsofmeasure.org", "code": "mL", "value": 2.5 }, "method": { "coding": [ { "system": "http://snomed.info/sct", "code": "129300006", "display": "Puncture - action" } ] }, "bodySite": { "coding": [ { "system": "http://snomed.info/sct", "code": "14975008", "display": "Forearm structure (body structure)" } ] } },
processing
SHOULD be updated if processing occurs on the sample which affects later use, e.g. additives added"processing": [ { "description": "Acidify to pH < 3.0 with 6 N HCl.", "procedure": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0373", "code": "ACID" } ] }, "additive": [ { "display": "6 N HCl" } ], "timeDateTime": "2015-08-18T08:10:00Z" } ],
container
The UK Core STU3 version of Specimen backports the R5 changes to the container BackboneElement to support capturing of storage location for a sample (through `container.location`) and recursive capture of device identifiers (e.g. tube, well, rack, freezer through `container.device`).The container.identifier should match the identifier associated with the barcode for the tube/collection device. This can be searched using the container-id SearchParameter.
Additional examples/guidance will be provided within this IG once use of the fields has been appropriately tested.
Sample tracking information SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing, on either the output or input elements. This information MAY include consignment number, destination, date sent etc.
If known, the container type SHOULD be populated, using the example bound ValueSet, in SNOMED CT. If an appropraite code cannot be found, the specimen container type should be populated using free text, in Specimen.container.type.text. Additional container elements, such as capacity or specimenQuantity MAY be populated if known.
"container": [ { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location", "valueReference": { "reference": "Location/Location-NTGLHFridge-Example" } } ], "identifier": [ { "system": "urn:iso:std:iso:15417:2007", "value": "ABC-abc-1234" } ], "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "702284002", "display": "Non-evacuated blood collection tube, lithium heparin" } ] } } ]
condition
Used to record the condition of a specimen. Within Genomics, SHOULD be used to record the fixed/frozen state, using the UK Core bound ValueSet."condition": [ { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PrimarySampleState", "code": "fresh", "display": "Fresh" } ] } ]
StructureDefinition Subscription
The Genomics Subscription is currently pending Clinical and Technical Assurance of the base UKCore resource. Once this profile becomes active in UKCore its suitability for use and need for profiling within Genomics will be assessed.
The profile for the NHSDigital/England Subscription is provided below for completeness.
In the Alpha build of the Genomic Medicine Service, MESH/email will be used as the primary notification procedure though a FHIR native solution is being investigated.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Subscription | HL7 International | trial-use |
| Subscription | C | DomainResource | Element idSubscriptionShort description Server push subscription criteria Alternate namesWebHook, Hook, Routing Rule DefinitionThe subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSubscription.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSubscription.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSubscription.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSubscription.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idSubscription.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idSubscription.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idSubscription.statusShort description requested | active | error | off DefinitionThe status of the subscription, which marks the server state for managing the subscription. A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The status of a subscription. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ C | 0..* | ContactPoint | Element idSubscription.contactShort description Contact details for source (e.g. troubleshooting) DefinitionContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| end | Σ | 0..1 | instant | Element idSubscription.endShort description When to automatically delete the subscription DefinitionThe time for the server to turn the subscription off. The server is permitted to deviate from this time but should observe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reason | Σ | 1..1 | string | Element idSubscription.reasonShort description Description of why this subscription was created DefinitionA description of why this subscription is defined. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| criteria | Σ | 1..1 | string | Element idSubscription.criteriaShort description Rule for server push DefinitionThe rules that the server should use to determine when to generate notifications for this subscription. The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| error | Σ | 0..1 | string | Element idSubscription.errorShort description Latest error note DefinitionA record of the last error that occurred when the server processed a notification. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| channel | Σ | 1..1 | BackboneElement | Element idSubscription.channelShort description The channel on which to report matches to the criteria DefinitionDetails where to send notifications when resources are received that meet the criteria. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.channel.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.channel.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.channel.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | codeBinding | Element idSubscription.channel.typeShort description rest-hook | websocket | email | sms | message DefinitionThe type of channel to send notifications on. Note that FHIR strings SHALL NOT exceed 1MB in size The type of method used to execute a subscription. SubscriptionChannelType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| endpoint | Σ | 0..1 | url | Element idSubscription.channel.endpointShort description Where the channel points to DefinitionThe url that describes the actual end-point to send messages to. For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payload | Σ | 0..1 | codeBinding | Element idSubscription.channel.payloadShort description MIME type to send, or omit for no payload DefinitionThe mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured. The mime type of an attachment. Any valid mime type is allowed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| header | Σ | 0..* | string | Element idSubscription.channel.headerShort description Usage depends on the channel type DefinitionAdditional headers / information to send as part of the notification. Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
StructureDefinition Task
The core workflow resource for managing processing of a ServiceRequest from order through to delivery of a DiagnosticReport and completion is Task. Task tracking is a core requirement of the central Genomic Medicine Service.
Each ServiceRequest submitted will instantiate a series of High Level Tasks, which MAY be assigned to different organizations for managing the test request e.g. Sample Processing, Interpretation, Reporting etc. The full list of possible Task types/codes, their associated business statuses, and status reasons is pending internal review.
Tasks will be automatically created by the central broker but updates to statuses and attachment of input/output resources is the responsibility of the assigned organizations.
An illustrative diagram of the links between ServiceRequests and Tasks are provided below (for the initial sample processing). Note: not all resource links are represented, to increase legibility of the diagram. In most cases, the full library of 10 tasks, as defined within Genomic-Task-Code, will be 'spun-up', on submission of a Test order. Tasks related to Samples may be duplicated per Sample to allow tracking of work related to individual Samples as part of the same test request, or equally, may be omitted as in the case of Re-Analysis or Re-Interpretation where data from an existing sample is used, eliminating the need for additional wet-work. For the full cardinality breakdown see further guidance for the Task.code element.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Task | HL7 International | trial-use |
| Task | C | DomainResource | Element idTaskShort description A task to be performed DefinitionA task to be performed.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idTask.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idTask.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idTask.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idTask.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idTask.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idTask.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | 0..* | Identifier | Element idTask.identifierShort description Task Instance Identifier DefinitionThe business identifier for this task. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Element idTask.instantiatesCanonicalShort description Formal definition of task DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. Enables a formal definition of how he task is to be performed, enabling automation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..1 | uri | Element idTask.instantiatesUriShort description Formal definition of task DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(Resource) | Element idTask.basedOnShort description Request fulfilled by this task DefinitionBasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| groupIdentifier | Σ | 0..1 | Identifier | Element idTask.groupIdentifierShort description Requisition or grouper id DefinitionAn identifier that links together multiple tasks and other requests that were created in the same context. Billing and/or reporting can be linked to whether multiple requests were created as a single unit. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| partOf | Σ C | 0..* | Reference(Task) | Element idTask.partOfShort description Composite task DefinitionTask that this particular task is part of. Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). This should usually be 0..1. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idTask.statusShort description draft | requested | received | accepted | + DefinitionThe current status of the task. These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. Note that FHIR strings SHALL NOT exceed 1MB in size The current status of the task. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| statusReason | Σ | 0..1 | CodeableConcept | Element idTask.statusReasonShort description Reason for current status DefinitionAn explanation as to why this task is held, failed, was refused, etc. This applies to the current status. Look at the history of the task to see reasons for past statuses. Codes to identify the reason for current status. These will typically be specific to a particular workflow. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| businessStatus | Σ | 0..1 | CodeableConcept | Element idTask.businessStatusShort description E.g. "Specimen collected", "IV prepped" DefinitionContains business-specific nuances of the business state. There's often a need to track substates of a task - this is often variable by specific workflow implementation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | Σ | 1..1 | codeBinding | Element idTask.intentShort description unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option DefinitionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". Distinguishes whether the task is a proposal, plan or full order. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | 0..1 | codeBinding | Element idTask.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the Task should be addressed with respect to other requests. Used to identify the service level expected while performing a task. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority The task's priority. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | Σ | 0..1 | CodeableConcept | Element idTask.codeShort description Task Type DefinitionA name or code (or both) briefly describing what the task involves. The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. Codes to identify what the task involves. These will typically be specific to a particular workflow. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | Σ | 0..1 | string | Element idTask.descriptionShort description Human-readable explanation of task DefinitionA free-text description of what is to be performed. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | Σ C | 0..1 | Reference(Resource) | Element idTask.focusShort description What task is acting on DefinitionThe request being actioned or the resource being manipulated by this task. Used to identify the thing to be done. If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| for | Σ C | 0..1 | Reference(Resource) | Element idTask.forShort description Beneficiary of the Task Alternate namesPatient DefinitionThe entity who benefits from the performance of the service specified in the task (e.g., the patient). Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | Element idTask.encounterShort description Healthcare event during which this task originated DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. For some tasks it may be important to know the link between the encounter the task originated within. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| executionPeriod | Σ C | 0..1 | Period | Element idTask.executionPeriodShort description Start and end time of execution DefinitionIdentifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end). A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| authoredOn | C | 0..1 | dateTime | Element idTask.authoredOnShort description Task Creation Date Alternate namesCreated Date DefinitionThe date and time this task was created. Most often used along with lastUpdated to track duration of task to supporting monitoring and management. The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| ||
| lastModified | Σ C | 0..1 | dateTime | Element idTask.lastModifiedShort description Task Last Modified Date Alternate namesUpdate Date DefinitionThe date and time of last modification to this task. Used along with history to track task activity and time in a particular task state. This enables monitoring and management. The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| ||
| requester | Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idTask.requesterShort description Who is asking for task to be done DefinitionThe creator of the task. Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performerType | 0..* | CodeableConceptBinding | Element idTask.performerTypeShort description Requested performer DefinitionThe kind of participant that should perform the task. Use to distinguish tasks on different activity queues. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type(s) of task performers allowed. ProcedurePerformerRoleCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| owner | Σ C | 0..1 | Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idTask.ownerShort description Responsible individual Alternate namesPerformer, Executer DefinitionIndividual organization or Device currently responsible for task execution. Identifies who is expected to perform this task. Tasks may be created with an owner not yet identified. Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ C | 0..1 | Reference(Location) | Element idTask.locationShort description Where task occurs DefinitionPrincipal physical location where the this task is performed. Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | 0..1 | CodeableConcept | Element idTask.reasonCodeShort description Why task is needed DefinitionA description or code indicating why this task needs to be performed. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reasonReference | C | 0..1 | Reference(Resource) | Element idTask.reasonReferenceShort description Why task is needed DefinitionA resource reference indicating why this task needs to be performed. Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| insurance | C | 0..* | Reference(ClaimResponse | Coverage) | Element idTask.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ClaimResponse | Coverage) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | Element idTask.noteShort description Comments made about the task DefinitionFree-text information captured about the task as it progresses. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relevantHistory | C | 0..* | Reference(Provenance) | Element idTask.relevantHistoryShort description Key events in history of the Task Alternate namesStatus History DefinitionLinks to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| restriction | 0..1 | BackboneElement | Element idTask.restrictionShort description Constraints on fulfillment tasks DefinitionIf the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. Sometimes when fulfillment is sought, you don't want full fulfillment. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idTask.restriction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| repetitions | 0..1 | positiveInt | Element idTask.restriction.repetitionsShort description How many times to repeat DefinitionIndicates the number of times the requested action should occur. E.g. order that requests monthly lab tests, fulfillment is sought for 1. 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| period | C | 0..1 | Period | Element idTask.restriction.periodShort description When fulfillment sought DefinitionOver what time-period is fulfillment sought. E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. Note that period.high is the due date representing the time by which the task should be completed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| recipient | C | 0..* | Reference(Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idTask.restriction.recipientShort description For whom is fulfillment sought? DefinitionFor requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| input | 0..* | BackboneElement | Element idTask.inputShort description Information used to perform task Alternate namesSupporting Information DefinitionAdditional information that may be needed in the execution of the task. Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idTask.input.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 1..1 | CodeableConcept | Element idTask.input.typeShort description Label for the input Alternate namesName DefinitionA code or description indicating how the input is intended to be used as part of the task execution. Inputs are named to enable task automation to bind data and pass it from one task to the next. If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| value[x] | 1..1 | Element idTask.input.value[x]Short description Content to use in performing the task DefinitionThe value of the input parameter as a basic type. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueAddress | Address | Data type | ||||
| valueAge | Age | Data type | ||||
| valueAnnotation | Annotation | Data type | ||||
| valueAttachment | Attachment | Data type | ||||
| valueBase64Binary | base64Binary | Data type | ||||
| valueBoolean | boolean | Data type | ||||
| valueCanonical | canonical | Data type | ||||
| valueCode | code | Data type | ||||
| valueCodeableConcept | CodeableConcept | Data type | ||||
| valueCoding | Coding | Data type | ||||
| valueContactDetail | ContactDetail | Data type | ||||
| valueContactPoint | ContactPoint | Data type | ||||
| valueContributor | Contributor | Data type | ||||
| valueCount | Count | Data type | ||||
| valueDataRequirement | DataRequirement | Data type | ||||
| valueDate | date | Data type | ||||
| valueDateTime | dateTime | Data type | ||||
| valueDecimal | decimal | Data type | ||||
| valueDistance | Distance | Data type | ||||
| valueDosage | Dosage | Data type | ||||
| valueDuration | Duration | Data type | ||||
| valueExpression | Expression | Data type | ||||
| valueHumanName | HumanName | Data type | ||||
| valueId | id | Data type | ||||
| valueIdentifier | Identifier | Data type | ||||
| valueInstant | instant | Data type | ||||
| valueInteger | integer | Data type | ||||
| valueMarkdown | markdown | Data type | ||||
| valueMeta | Meta | Data type | ||||
| valueMoney | Money | Data type | ||||
| valueOid | oid | Data type | ||||
| valueParameterDefinition | ParameterDefinition | Data type | ||||
| valuePeriod | Period | Data type | ||||
| valuePositiveInt | positiveInt | Data type | ||||
| valueQuantity | Quantity | Data type | ||||
| valueRange | Range | Data type | ||||
| valueRatio | Ratio | Data type | ||||
| valueReference | Reference | Data type | ||||
| valueRelatedArtifact | RelatedArtifact | Data type | ||||
| valueSampledData | SampledData | Data type | ||||
| valueSignature | Signature | Data type | ||||
| valueString | string | Data type | ||||
| valueTime | time | Data type | ||||
| valueTiming | Timing | Data type | ||||
| valueTriggerDefinition | TriggerDefinition | Data type | ||||
| valueUnsignedInt | unsignedInt | Data type | ||||
| valueUri | uri | Data type | ||||
| valueUrl | url | Data type | ||||
| valueUsageContext | UsageContext | Data type | ||||
| valueUuid | uuid | Data type | ||||
| output | 0..* | BackboneElement | Element idTask.outputShort description Information produced as part of task DefinitionOutputs produced by the Task. Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idTask.output.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 1..1 | CodeableConcept | Element idTask.output.typeShort description Label for output Alternate namesName DefinitionThe name of the Output parameter. Outputs are named to enable task automation to bind data and pass it from one task to the next. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| value[x] | 1..1 | Element idTask.output.value[x]Short description Result of output DefinitionThe value of the Output parameter as a basic type. Task outputs can take any form. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueAddress | Address | Data type | ||||
| valueAge | Age | Data type | ||||
| valueAnnotation | Annotation | Data type | ||||
| valueAttachment | Attachment | Data type | ||||
| valueBase64Binary | base64Binary | Data type | ||||
| valueBoolean | boolean | Data type | ||||
| valueCanonical | canonical | Data type | ||||
| valueCode | code | Data type | ||||
| valueCodeableConcept | CodeableConcept | Data type | ||||
| valueCoding | Coding | Data type | ||||
| valueContactDetail | ContactDetail | Data type | ||||
| valueContactPoint | ContactPoint | Data type | ||||
| valueContributor | Contributor | Data type | ||||
| valueCount | Count | Data type | ||||
| valueDataRequirement | DataRequirement | Data type | ||||
| valueDate | date | Data type | ||||
| valueDateTime | dateTime | Data type | ||||
| valueDecimal | decimal | Data type | ||||
| valueDistance | Distance | Data type | ||||
| valueDosage | Dosage | Data type | ||||
| valueDuration | Duration | Data type | ||||
| valueExpression | Expression | Data type | ||||
| valueHumanName | HumanName | Data type | ||||
| valueId | id | Data type | ||||
| valueIdentifier | Identifier | Data type | ||||
| valueInstant | instant | Data type | ||||
| valueInteger | integer | Data type | ||||
| valueMarkdown | markdown | Data type | ||||
| valueMeta | Meta | Data type | ||||
| valueMoney | Money | Data type | ||||
| valueOid | oid | Data type | ||||
| valueParameterDefinition | ParameterDefinition | Data type | ||||
| valuePeriod | Period | Data type | ||||
| valuePositiveInt | positiveInt | Data type | ||||
| valueQuantity | Quantity | Data type | ||||
| valueRange | Range | Data type | ||||
| valueRatio | Ratio | Data type | ||||
| valueReference | Reference | Data type | ||||
| valueRelatedArtifact | RelatedArtifact | Data type | ||||
| valueSampledData | SampledData | Data type | ||||
| valueSignature | Signature | Data type | ||||
| valueString | string | Data type | ||||
| valueTime | time | Data type | ||||
| valueTiming | Timing | Data type | ||||
| valueTriggerDefinition | TriggerDefinition | Data type | ||||
| valueUnsignedInt | unsignedInt | Data type | ||||
| valueUri | uri | Data type | ||||
| valueUrl | url | Data type | ||||
| valueUsageContext | UsageContext | Data type | ||||
| valueUuid | uuid | Data type |
| FHIR | MDS | HL7v2 |
|---|---|---|
| Task.executionPeriod.start | PLCM activity - Activity start date and time | Derived from TQ1-7 in the ORL response message for the activity based on the OML request |
| Task.executionPeriod.end | PLCM activity - Activity end date and time | Derived from TQ1-8 in the ORL response message for the activity based on the OML request |
| Task.owner | PLCM activity - ODS code of organisation submitting to PLCM, PLCM activity - ODS code of organisation delivering requested test, PLCM activity - ODS code of the laboratory site delivering requested test | OBR-32.7 if sourced from principle results interpreter, OBX-32.10, AFF-2.10 associated with performing organization |
| Task.status | PLCM activity - Sample plating quality control | Implied through status recorded in ORC-25 indicating plating quality control had passed |
| Task.statusReason | PLCM activity - Sample plating quality control fail code | ORC-25 |
| Task.output | Extracted specimen - Location details | SAC-15 |
Additional Guidance
- basedOn
- status
- statusReason
- businessStatus
- code
- focus
- for
- executionPeriod
- authoredOn
- lastModified
- requester
- owner
- note
- input
- output
basedOn
This element will not be used within the Genomic Medicine Service. The ServiceRequest a Task is seeking to fulfill SHALL be referenced through the `focus` element. Specimen resources being acted upon by tasks related to specimen prep/processing SHOULD be referenced through the `Task.input` element.status
Initially, automatically populated by the central service upon instantiation. Tasks will be first marked as 'draft' until their prerequisites have been satisfied, after which they will be marked as 'requested' until accepted/claimed by an organization. Upon acceptance, the owning organization is responsible for updating the status up until completion (or if the owning organization is not integrated into the GMS, the organization who has referred the task to the unintegrated org).If a ServiceRequest is cancelled, any Tasks which have not already moved into in-progress SHALL be moved into the cancelled state, any in-progress Tasks will require lab processes to manage closure of the Task and appropriate reimbursement. For a full list of possible automatic cascading of ServiceRequest.status to Task.status please see additional guidance on the status element on the UKCore-ServiceRequest profile page.
It is not expected that Task statuses will propagate up to the ServiceRequest status, though certain task failure types may require revokation of the authorising request (pending investigation).
For the full list of expected Task statuses in use by the GMS, please refer to the table below. For the allowed Task status transitions, please see the FHIR R4 Task state machine model.
| Status | Description | Genomic workflow usage |
|---|---|---|
| Draft | The task is not yet ready to be acted upon. | Initial state for Tasks. Used for tasks which require prerequisite tasks to be completed first. |
| Requested | The task is ready to be acted upon and action is sought. | Status indicating a task can be worked on/claimed, all prerequisites have been satisfied. |
| Received | A potential performer has claimed ownership of the task and is evaluating whether to perform it. | NOT USED within Genomics as Tasks will be polled for rather than being sent out to assigned organizations. Most likely not used unless tasks are automatically assigned and organizations are notified by the central service, e.g. to GLH. |
| Accepted | The potential performer has agreed to execute the task but has not yet started work. | Used when an assigned owner has accepted the task after being assigned. |
| Rejected | The potential performer who claimed ownership of the task has decided not to execute it prior to performing any action. | Used if an organization was assigned to a task but is unable to perform work against it. It is expected if an alternative organization can be assigned, this is done as an owner update rather than marking the task as rejected. If subsequent work does occur, a duplicate task will need to be created as the 'rejected' state is a terminal one. |
| Ready | The task is ready to be performed, but no action has yet been taken. Used in place of requested/received/accepted/rejected when request assignment and acceptance is a given. | NOT USED within Genomics as it is not assumed that Tasks will be automatically accepted when prerequisites are satisfied. |
| Cancelled | The task was not completed. | Used when a task has been created but later identified as unneeded, e.g. due to modifications to test order such as the ServiceRequest being cancelled. Automatically set by the central broker. |
| In Progress | The task has been started but is not yet complete. | When work has commenced. |
| On Hold | The task has been started but work has been paused. | A holding state where work is expected to continue but is being blocked through some external issue. Suppliers will need to state reason why work is on hold through the statusReason field e.g. Awaiting Sample. |
| Failed | The task was attempted but could not be completed due to some error. | Indicates the task cannot continue and is unrcoverable without external intervention. If modifications to the test order allow the task to be resumed, a new task should be created e.g. a new sample is provided to replace a previous sample which has failed quality control. If the Task results in an unrecoverable error, the ServiceRequest may need to be revoked. |
| Completed | The task has been completed. | Marked once all actions against a task are complete, and follow on Tasks can commence. |
| Entered in Error | The task should never have existed and is retained only because of the possibility it may have used. | May be used if user created Tasks are created in error, e.g. duplicate Tasks, or Tasks have been created by the central broker and the ServiceRequest has subsequently been marked as entered-in-error. |
"status": "rejected",
statusReason
Reasons why a Task has been marked as on-hold, cancelled etc. SHOULD use the Genomic-Task-StatusReason CodeSystem. NOTE: The list of appropriate statusReasons is pending finalization.If a code from the linked CodeSystem is not applicable, the code of other SHOULD be used, with a free text reason captured within Task.statusReason.text.
"statusReason": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/task-status-reason-genomics", "code": "further-information-needed", "display": "Further Information Needed" } ] },
businessStatus
Genomic specific business statuses for capturing more granular information as part of processing the task. SHOULD use the Genomic-Business-Status CodeSystem. NOTE: The list of appropriate buinessStatuses is pending finalization. Mapping business statuses to the high level container Tasks and statuses is still ongoing.If a code from the linked CodeSystem is not applicable, the code of other SHOULD be used, with a free text status captured within Task.businessStatus.text.
"businessStatus": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/business-status-genomics", "code": "sample-sent", "display": "Sample Sent" } ] },
code
High level coding for the Task, matches the NGTP stages for genomic test processing. Clients SHOULD use the Genomic-Task-Code CodeSystem. NOTE: The list of appropriate codes is pending finalization.The currently allowed code list and their definition is provided in the table below. The table also provides the cardinality of each Task per ServiceRequest or Sample attached to the request as generated by the central broker on submission of a test request. Note: the cardinalities listed reflect the number of concurrent active tasks per service request at any one time, there may be cases where additional Tasks need to be spun up manually, e.g. on failure such as when a new sample needs to be processed after a previous sample fails Quality Control, or when further preparation is required. This cardinality supports the use cases for both requests with multiple participants, e.g. Duo/Trio, and multiple samples per participant e.g. Cancer testing.
| Task.code display | Definition of work within Task | Cardinality (general case) | Cardinality (Reanalysis/Reinterpretation) | Cardinality (DNA Storage) |
|---|---|---|---|---|
| Process Genomic Test Request | Test code requested is ratified by the lab against provided patient information (checking eligibility) | 1..1 (per ServiceRequest) | 1..1 | 1..1 |
| Request & Sample Alignment | The lab confirms/validates the data and sample(s) required for given test type are present | 1..* (1 per Specimen referenced from or referencing the ServiceRequest) | 1..1 (At least 1 will always be required, e.g. for validation of data in the No Sample scenario) | 1..* (per Sample) |
| Sample Preparation | Sample is prepared, as appropriate for the selected test type, and DNA extracted. May have multiples if further preparation is required | 1..* (1 per Sample) | 0..0 (Not required for Reanalysis/Reinterpretation requests where a sample does not need to be prepared) | 1..* (1 per Sample) |
| Sample Processing | DNA sample(s) are sequenced, generating read/sequence data to feed into analysis | 1..* (1 per Sample or extracted DNA sample) | 0..0 (Not required for Reanalysis/Reinterpretation requests where a sample does not need to be sequenced) | 0..0 (Not required for DNA storage where a sample does not need to be sequenced) |
| Genetic/Genomic Data Processing | Sequence data is passed through a bio-pipeline, generates variant priorities lists for analysis | 1..* (1 per Sample or read data) | 0..* (For Reanalysis, should match the number of Samples for the parent request. Not required for Reinterpretation requests) | 0..0 (Not required for DNA storage requests) |
| Interpretation | Results analysis is organised and interpreted by a Clincial Scientist | 1..* (1 per Sample or variant priorities list) | 1..* (For Reanalysis/Reinterpretation, should match the number of Samples for the parent request | 0..0 (Not required for DNA storage requests) |
| Produce Interim Report | A report is created and deemed interim pending MDT, if necessary | 1..* (1 per Sample. TBC whether one interim report would be generated per sample/set of genetic data or 1 per request) | 1..* (For Reanalysis/Reinterpretation, should match the number of Samples for the parent request | 0..0 (Not required for DNA storage requests) |
| Genomic MDT | Multi-Diciplinary-Team consults on the interim report | 1..1 (max 1 per ServiceRequest, for the purposes of the Alpha an MDT task will always be created, even if not needed) | 1..1 | 0..0 (Not required for DNA storage requests) |
| Produce Final Report | Interim report is deemed final or is updated following MDT | 1..1 (per ServiceRequest) | 1..1 | 1..1 |
| Distribute Report | Final report is distributed or marked as distributable/available | 1..1 (per ServiceRequest or Final Report) | 1..1 | 1..1 |
Rendered within a diagram, the Task cardinalities and their inputs are illustrated in the diagram below:
"code": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/task-code-genomics", "code": "sample-processing", "display": "Sample Processing" } ] },
focus
The ServiceRequest the Task is fulfilling. Autopopulated by the central service."focus": { "reference": "ServiceRequest/ServiceRequest-SavedTestOrder-Example" },
for
A reference to the Patient resource or the identifier, NHS number, for the patient for whom the Task is for. Autopopulated by the central service if the Task is automatically generated.If a Task is created by client system or user interaction, for SHALL be populated with a reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS.
"for": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
executionPeriod
MAY be used to capture start and end DateTimes associated with execution of a Task. It is expected the start time will be populated as a Task is moved to in-progress and the end time will be populated as a Task is marked as completed. Usage of this field will be investigated during the Alpha phase of the Genomic Order Management project as timelines for task execution can also be derived from the AuditEvents recorded as Tasks are updated."executionPeriod": { "start": "2023-10-31T10:25:05+00:00", "end": "2023-11-15T16:45:05+00:00" },
authoredOn
Autopopulated by the central service on creation of the Task."authoredOn": "2023-09-18T18:30:00Z"
lastModidified
Time at which a change to the task was made, e.g. status updated. SHALL be updated on change."lastModified": "2023-09-18T19:11:00Z"
requester
The original requester of the ServiceRequest the Task is fulfilling. Autopopulated by the central service."requester": { "reference": "PractitionerRole/PractitionerRole-GeneSmithENT-Example" },
owner
Autopopulated by the central service if a performer is assigned at Test submission. By default, this will the Home GLH for the submitting organization, unless an alternative is specified. The Home GLH/original performer (managing entity) SHOULD remain the owner for the Process Genomic Test Task, throughout the test order-fulfillment process.This field can be updated by the organization claiming the task (though this could also be autopopulated if automated per test routing tables are integrated into the central service functionality). Owner SHOULD be populated using organization ODS code references.
The responsibility for routing/reassigning ownership of Tasks lies with the current owner following the transfers of responsibility as per the National Genomic Testing Process (NGTP). The different scenarios for how follow-on routing may be achieved is summarised in the points below:
- In most cases, by default the test will be routed to the home GLH (or other lab/GLH as dictated by the initial routing table).
- This would mean all Tasks by default would have this organization, e.g. home GLH, as the initial owner, it would then be the responsibility of the GLH to reassign tasks to other organizations, where they 'send away' or commission work.
- Once that work is complete, the send-away organization can choose to reassign the current Task (where another organization needs to conduct work against the same Task before it can be marked as complete)/or assign the follow-on Task (where the current task can be marked as complete) to the next organization, if this is known.
- If the next organization to send work to is unknown, responsibility should lie with the original/previous owner e.g. Home GLH to reassign the task to the next organization that needs to complete work. This should be captured by having the current owner reassign the task back to the GLH (or organization which assigned the task to them) if further work needs to occur within the current task; or the next task in the NGTP moves from the draft state into the requested state (indicating all its prerequisites have been satisfied). The owner of that task, e.g home GLH, then either starts work or assigns this to the relevant organization.
- In further phases, a routing advice service may be provided by NHS England to aid organizations in identifying which organization should be assigned, after completing their work.
Tasks assigned to a particular organization SHOULD be searched for using the owner search parameter with the :identifier modifier i.e. [base]/Task?owner:identifier=8J834 or [base]/Task?owner:identifier=https://fhir.nhs.uk/Id/ods-organization-code|8J834
"owner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "69010" }, "display": "Pathology Lab - ADDENBROOKE'S HOSPITAL LABORATORY" },
note
Used for messaging between owner and other orgnizations e.g. during handover of task or requesting information from requesting clinician."note": [ { "text": "Sample has not been received within 4 week window. Task will be closed unless further communication is received" } ]
input
Used to attach inputs to a Task, if relevant. e.g. references to Specimen's which a Sample Processing task is acting on. No CodeSystem exists for this field as of publication but this will be investigated as future work.Specimen references SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing. This is to clearly disambiguate which specimen a task is acting on, where multiple specimens are necessary for processing the test request.
The table below provides possible inputs that could be provided for certain Tasks as part of fulfillment of a test order. A finalised list is pending business analysis work to identify the operational data generated as fulfilment against a test order progresses and the need for this data to pass between organizations.
| Task.code display | Possible Task.input |
|---|---|
| Process Genomic Test Request | N/A, all information required should be part of or refernced from the ServiceRequest |
| Request & Sample Alignment | Specimen resource to be aligned and potentially Consent resources where these are captured post submission of a test request |
| Sample Preparation | Specimen resource to be prepared as part of this Task |
| Sample Processing | DNA Specimen resource to be sequenced as part of this Task as well as Consignment, Rack and Well identifiers to allow for specimen tracking |
| Genetic/Genomic Data Processing | Sequence data generated from the previous Task, potentially referenced using DocumentReference resources, these SHOULD reference the Specimen from which the data originated |
| Interpretation | Variant Priorities lists generated from the previous Task, the representation of these lists is still under investigation |
| Produce Interim Report | Guidance/Recommendations generated though data interpretation, the representation of these items is still under investigation |
| Genomic MDT | Interim reports, references to Diagnostic report resources containing either structured Genomic reports or binary representations of the reports |
| Produce Final Report | Interim reports and potentially recommendations from the MDT, whether these are represented within the DiagnosticReport itself or contained as other resource types is still under investigation |
| Distribute Report | The final report to be distributed |
"input": [ { "type": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/AdditionalInfoTypeGenomics", "code": "Specimen", "display": "Specimen" } ] }, "valueReference": { "reference": "Specimen/Specimen-CancerSolidTumor-Example" } } ]
output
Used to attach outputs from a Task, if relevant. e.g. VUS files during processing or a DiagnosticReport upon completion of reporting stage. No CodeSystem exists for this field as of publication but this will be investigated as future work.Sample tracking information SHOULD be added to Tasks acting on Specimen resources, e.g. Tasks marked SamplePreparation or SampleProcessing, on either the output or input elements. This information MAY include consignment number, destination, date sent etc. Further modelling of the types/format expected are pending clinical scenarios.
The table below provides possible outputs that could be generated by certain Tasks as part of fulfillment of a test order. A finalised list is pending business analysis work to identify the operational data generated as fulfilment against a test order progresses and the need for this data to pass between organizations.
| Task.code display | Possible Task.output |
|---|---|
| Process Genomic Test Request | N/A, may result in updates to the ServiceRequest if codes or supporting information needs to change |
| Request & Sample Alignment | Aligned Specimen resource for request (except for Reanalysis/Reinterpretation) |
| Sample Preparation | DNA Specimen resource as well as Consignment, Rack and Well identifiers to allow for specimen tracking |
| Sample Processing | Sequence/Read data |
| Genetic/Genomic Data Processing | Variant information |
| Interpretation | Potentially structured guidance/recommendations |
| Produce Interim Report | Interim reports |
| Genomic MDT | Potentially ammended Interim/combined report or recommendations from MDT |
| Produce Final Report | Final Report |
| Distribute Report | N/A, final report will be included as input to Task |
"output": [ { "type": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/AdditionalInfoTypeGenomics", "code": "DiagnosticReport", "display": "DiagnosticReport" } ] }, "valueReference": { "reference": "DiagnosticReport/DiagnosticReport-PhoebeSmithGeneticReport-Example" } } ]
StructureDefinition PlanDefinition
FHIR representation for a DGTS Genomic Test Package. This is a definitional resource and available read-only from the DGTS FHIR API.
The below profile is provided to support parsing for clients if returned through a GET request.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/PlanDefinition | HL7 International | trial-use |
| PlanDefinition | C | DomainResource | Element idPlanDefinitionShort description The definition of a plan for a series of actions, independent of any specific patient or context DefinitionThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPlanDefinition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPlanDefinition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPlanDefinition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPlanDefinition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 0..1 | uri | Element idPlanDefinition.urlShort description Canonical identifier for this plan definition, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this plan definition 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 at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. Allows the plan definition to be referenced by a single globally unique identifier. 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. The 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. In 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 element to indicate where the current master source of the resource can be found. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idPlanDefinition.identifierShort description Additional identifier for the plan definition DefinitionA formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | Element idPlanDefinition.versionShort description Business version of the plan definition DefinitionThe identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different plan definition instances that have the same identifier 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 plan definition with the format [url]|[version]. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 0..1 | string | Element idPlanDefinition.nameShort description Name for this plan definition (computer friendly) DefinitionA natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. The cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints
| ||
| title | Σ | 0..1 | string | Element idPlanDefinition.titleShort description Name for this plan definition (human friendly) DefinitionA short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subtitle | 0..1 | string | Element idPlanDefinition.subtitleShort description Subordinate title of the plan definition DefinitionAn explanatory or alternate title for the plan definition giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | Σ | 0..1 | CodeableConceptBinding | Element idPlanDefinition.typeShort description order-set | clinical-protocol | eca-rule | workflow-definition DefinitionA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of PlanDefinition. PlanDefinitionType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idPlanDefinition.statusShort description draft | active | retired | unknown DefinitionThe status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not. The lifecycle status of an artifact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| experimental | Σ | 0..1 | boolean | Element idPlanDefinition.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. Allows filtering of plan definitions that are appropriate for use versus not. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject[x] | 0..1 | Binding | Element idPlanDefinition.subject[x]Short description Type of individual the plan definition is focused on DefinitionA code or group definition that describes the intended subject of the plan definition. Patient The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| subjectCodeableConcept | CodeableConcept | Data type | ||||
| subjectReference | Reference(Group) | Data type | ||||
| date | Σ | 0..1 | dateTime | Element idPlanDefinition.dateShort description Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the plan definition was published. 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 plan definition changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | Element idPlanDefinition.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the plan definition. Helps establish the "authority/credibility" of the plan definition. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. 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 plan definition. This item SHOULD be populated unless the information is available from context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | Element idPlanDefinition.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | Σ | 0..1 | markdown | Element idPlanDefinition.descriptionShort description Natural language description of the plan definition DefinitionA free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| useContext | Σ | 0..* | UsageContext | Element idPlanDefinition.useContextShort description The context that the content is intended to support DefinitionThe 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 plan definition instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | Element idPlanDefinition.jurisdictionShort description Intended jurisdiction for plan definition (if applicable) DefinitionA legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..1 | markdown | Element idPlanDefinition.purposeShort description Why this plan definition is defined DefinitionExplanation of why this plan definition is needed and why it has been designed as it has. This element does not describe the usage of the plan definition. 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 plan definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| usage | 0..1 | string | Element idPlanDefinition.usageShort description Describes the clinical usage of the plan DefinitionA detailed description of how the plan definition is used from a clinical perspective. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| copyright | 0..1 | markdown | Element idPlanDefinition.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| approvalDate | 0..1 | date | Element idPlanDefinition.approvalDateShort description When the plan definition was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| lastReviewDate | 0..1 | date | Element idPlanDefinition.lastReviewDateShort description When the plan definition was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. If specified, this date follows the original approval date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectivePeriod | Σ C | 0..1 | Period | Element idPlanDefinition.effectivePeriodShort description When the plan definition is expected to be used DefinitionThe period during which the plan definition content was or is planned to be in active use. Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead. The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| topic | 0..* | CodeableConcept | Element idPlanDefinition.topicShort description E.g. Education, Treatment, Assessment DefinitionDescriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. High-level categorization of the definition, used for searching, sorting, and filtering. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | 0..* | ContactDetail | Element idPlanDefinition.authorShort description Who authored the content DefinitionAn individiual or organization primarily involved in the creation and maintenance of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| editor | 0..* | ContactDetail | Element idPlanDefinition.editorShort description Who edited the content DefinitionAn individual or organization primarily responsible for internal coherence of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reviewer | 0..* | ContactDetail | Element idPlanDefinition.reviewerShort description Who reviewed the content DefinitionAn individual or organization primarily responsible for review of some aspect of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endorser | 0..* | ContactDetail | Element idPlanDefinition.endorserShort description Who endorsed the content DefinitionAn individual or organization responsible for officially endorsing the content for use in some setting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relatedArtifact | 0..* | RelatedArtifact | Element idPlanDefinition.relatedArtifactShort description Additional documentation, citations DefinitionRelated artifacts such as additional documentation, justification, or bibliographic references. Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. Each related artifact is either an attachment, or a reference to another resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| library | 0..* | canonical(Library) | Element idPlanDefinition.libraryShort description Logic used by the plan definition DefinitionA reference to a Library resource containing any formal logic used by the plan definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| goal | 0..* | BackboneElement | Element idPlanDefinition.goalShort description What the plan is trying to accomplish DefinitionGoals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.goal.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.goal.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.goal.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | 0..1 | CodeableConcept | Element idPlanDefinition.goal.categoryShort description E.g. Treatment, dietary, behavioral DefinitionIndicates a category the goal falls within. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Example codes for grouping goals for filtering or presentation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| description | 1..1 | CodeableConcept | Element idPlanDefinition.goal.descriptionShort description Code or text describing the goal DefinitionHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". If no code is available, use CodeableConcept.text. Describes goals that can be achieved. SNOMEDCTClinicalFindings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| priority | 0..1 | CodeableConceptBinding | Element idPlanDefinition.goal.priorityShort description high-priority | medium-priority | low-priority DefinitionIdentifies the expected level of importance associated with reaching/sustaining the defined goal. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Indicates the level of importance associated with reaching or sustaining a goal. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| start | 0..1 | CodeableConcept | Element idPlanDefinition.goal.startShort description When goal pursuit begins DefinitionThe event after which the goal should begin being pursued. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identifies the types of events that might trigger the start of a goal. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| addresses | 0..* | CodeableConcept | Element idPlanDefinition.goal.addressesShort description What does the goal address DefinitionIdentifies problems, conditions, issues, or concerns the goal is intended to address. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identifies problems, conditions, issues, or concerns that goals may address. Condition/Problem/DiagnosisCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| documentation | 0..* | RelatedArtifact | Element idPlanDefinition.goal.documentationShort description Supporting documentation for the goal DefinitionDidactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources. Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| target | 0..* | BackboneElement | Element idPlanDefinition.goal.targetShort description Target outcome for the goal DefinitionIndicates what should be done and within what timeframe. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.goal.target.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.goal.target.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.goal.target.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| measure | 0..1 | CodeableConcept | Element idPlanDefinition.goal.target.measureShort description The parameter whose value is to be tracked DefinitionThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identifies types of parameters that can be tracked to determine goal achievement. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| detail[x] | 0..1 | Element idPlanDefinition.goal.target.detail[x]Short description The target value to be achieved DefinitionThe target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| detailCodeableConcept | CodeableConcept | Data type | ||||
| detailQuantity | Quantity | Data type | ||||
| detailRange | Range | Data type | ||||
| due | C | 0..1 | Duration | Element idPlanDefinition.goal.target.dueShort description Reach goal within DefinitionIndicates the timeframe after the start of the goal in which the goal should be met. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| action | 0..* | BackboneElement | Element idPlanDefinition.actionShort description Action defined by the plan DefinitionAn action or group of actions to be taken as part of the plan. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | 0..1 | string | Element idPlanDefinition.action.prefixShort description User-visible prefix for the action (e.g. 1. or A.) DefinitionA user-visible prefix for the action. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| title | 0..1 | string | Element idPlanDefinition.action.titleShort description User-visible title DefinitionThe title of the action displayed to a user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| description | 0..1 | string | Element idPlanDefinition.action.descriptionShort description Brief description of the action DefinitionA brief description of the action used to provide a summary to display to the user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| textEquivalent | 0..1 | string | Element idPlanDefinition.action.textEquivalentShort description Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system DefinitionA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| priority | 0..1 | codeBinding | Element idPlanDefinition.action.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the action should be addressed with respect to other actions. Note that FHIR strings SHALL NOT exceed 1MB in size Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | 0..* | CodeableConcept | Element idPlanDefinition.action.codeShort description Code representing the meaning of the action or sub-actions DefinitionA code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reason | 0..* | CodeableConcept | Element idPlanDefinition.action.reasonShort description Why the action should be performed DefinitionA description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| documentation | 0..* | RelatedArtifact | Element idPlanDefinition.action.documentationShort description Supporting documentation for the intended performer of the action DefinitionDidactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| goalId | 0..* | id | Element idPlanDefinition.action.goalIdShort description What goals this action supports DefinitionIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition. RFC 4122 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| subject[x] | 0..1 | Binding | Element idPlanDefinition.action.subject[x]Short description Type of individual the action is focused on DefinitionA code or group definition that describes the intended subject of the action and its children, if any. Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). Patient The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| subjectCodeableConcept | CodeableConcept | Data type | ||||
| subjectReference | Reference(Group) | Data type | ||||
| trigger | C | 0..* | TriggerDefinition | Element idPlanDefinition.action.triggerShort description When the action should be triggered DefinitionA description of when the action should be triggered. If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| condition | 0..* | BackboneElement | Element idPlanDefinition.action.conditionShort description Whether or not the action is applicable DefinitionAn expression that describes applicability criteria or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.condition.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.condition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.condition.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| kind | 1..1 | codeBinding | Element idPlanDefinition.action.condition.kindShort description applicability | start | stop DefinitionThe kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. Defines the kinds of conditions that can appear on actions. ActionConditionKind (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| expression | C | 0..1 | Expression | Element idPlanDefinition.action.condition.expressionShort description Boolean-valued expression DefinitionAn expression that returns true or false, indicating whether the condition is satisfied. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| input | 0..* | DataRequirement | Element idPlanDefinition.action.inputShort description Input data requirements DefinitionDefines input data requirements for the action. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| output | 0..* | DataRequirement | Element idPlanDefinition.action.outputShort description Output data definition DefinitionDefines the outputs of the action, if any. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relatedAction | 0..* | BackboneElement | Element idPlanDefinition.action.relatedActionShort description Relationship to another action DefinitionA relationship to another action such as "before" or "30-60 minutes after start of". When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.relatedAction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.relatedAction.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.relatedAction.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actionId | 1..1 | id | Element idPlanDefinition.action.relatedAction.actionIdShort description What action is this related to DefinitionThe element id of the related action. RFC 4122 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relationship | 1..1 | codeBinding | Element idPlanDefinition.action.relatedAction.relationshipShort description before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end DefinitionThe relationship of this action to the related action. Note that FHIR strings SHALL NOT exceed 1MB in size Defines the types of relationships between actions. ActionRelationshipType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| offset[x] | 0..1 | Element idPlanDefinition.action.relatedAction.offset[x]Short description Time offset for the relationship DefinitionA duration or range of durations to apply to the relationship. For example, 30-60 minutes before. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| offsetDuration | Duration | Data type | ||||
| offsetRange | Range | Data type | ||||
| timing[x] | 0..1 | Element idPlanDefinition.action.timing[x]Short description When the action should take place DefinitionAn optional value describing when the action should be performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| timingAge | Age | Data type | ||||
| timingDateTime | dateTime | Data type | ||||
| timingDuration | Duration | Data type | ||||
| timingPeriod | Period | Data type | ||||
| timingRange | Range | Data type | ||||
| timingTiming | Timing | Data type | ||||
| participant | 0..* | BackboneElement | Element idPlanDefinition.action.participantShort description Who should participate in the action DefinitionIndicates who should participate in performing the action described. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.participant.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.participant.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.participant.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 1..1 | codeBinding | Element idPlanDefinition.action.participant.typeShort description patient | practitioner | related-person | device DefinitionThe type of participant in the action. Note that FHIR strings SHALL NOT exceed 1MB in size The type of participant for the action. ActionParticipantType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| role | 0..1 | CodeableConcept | Element idPlanDefinition.action.participant.roleShort description E.g. Nurse, Surgeon, Parent DefinitionThe role the participant should play in performing the described action. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Defines roles played by participants for the action. ActionParticipantRole (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | 0..1 | CodeableConceptBinding | Element idPlanDefinition.action.typeShort description create | update | remove | fire-event DefinitionThe type of action to perform (create, update, remove). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of action to be performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| groupingBehavior | 0..1 | codeBinding | Element idPlanDefinition.action.groupingBehaviorShort description visual-group | logical-group | sentence-group DefinitionDefines the grouping behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines organization behavior of a group. ActionGroupingBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| selectionBehavior | 0..1 | codeBinding | Element idPlanDefinition.action.selectionBehaviorShort description any | all | all-or-none | exactly-one | at-most-one | one-or-more DefinitionDefines the selection behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection behavior of a group. ActionSelectionBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| requiredBehavior | 0..1 | codeBinding | Element idPlanDefinition.action.requiredBehaviorShort description must | could | must-unless-documented DefinitionDefines the required behavior for the action. Note that FHIR strings SHALL NOT exceed 1MB in size Defines expectations around whether an action or action group is required. ActionRequiredBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| precheckBehavior | 0..1 | codeBinding | Element idPlanDefinition.action.precheckBehaviorShort description yes | no DefinitionDefines whether the action should usually be preselected. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection frequency behavior for an action or group. ActionPrecheckBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| cardinalityBehavior | 0..1 | codeBinding | Element idPlanDefinition.action.cardinalityBehaviorShort description single | multiple DefinitionDefines whether the action can be selected multiple times. Note that FHIR strings SHALL NOT exceed 1MB in size Defines behavior for an action or a group for how many times that item may be repeated. ActionCardinalityBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| definition[x] | 0..1 | Element idPlanDefinition.action.definition[x]Short description Description of the activity to be performed DefinitionA reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | Data type canonical(ActivityDefinition | PlanDefinition | Questionnaire) | ||||
| definitionUri | uri | Data type | ||||
| transform | 0..1 | canonical(StructureMap) | Element idPlanDefinition.action.transformShort description Transform to apply the template DefinitionA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| dynamicValue | 0..* | BackboneElement | Element idPlanDefinition.action.dynamicValueShort description Dynamic aspects of the definition DefinitionCustomizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.dynamicValue.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.dynamicValue.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.dynamicValue.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| path | 0..1 | string | Element idPlanDefinition.action.dynamicValue.pathShort description The path to the element to be set dynamically DefinitionThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| expression | C | 0..1 | Expression | Element idPlanDefinition.action.dynamicValue.expressionShort description An expression that provides the dynamic value for the customization DefinitionAn expression specifying the value of the customized element. The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| action | 0..* | see (action) | There are no (further) constraints on this element Element idPlanDefinition.action.actionShort description A sub-action DefinitionSub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
|
Additional Guidance
identifier
SHALL be present. The DGTS test package readable ID assigned to the test package."identifier": [ { "system": "https://fhir.nhs.uk/Id/England-DigitalGenomicTestServices", "value": "TP231" }, { "system": "https://fhir.nhs.uk/Id/England-GenomicTestDirectory", "value": "R47", "use": "old" } ],
title
SHALL be present. The DGTS test package name."title": "Angelman syndrome",
status
SHALL be present. Used to represent the state of a test package. Mapping of statuses which do not match the required HL7 ValueSet, e.g. "Deprecated", are pending investigation."status": "active",
experimental
SHALL be present. For representing whether a test/test package is in pre-release."experimental": false,
version
SHALL be present. The DGTS Test Package version."version": "1.0",
useContext
SHALL be present. Used for capturing the specialties and requesting reasons which are eligible for this test/test package"useContext": [ { "code": { "code": "user", "system": "http://terminology.hl7.org/CodeSystem/usage-context-type" }, "valueCodeableConcept": { "coding": [ { "code": "400", "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode", "display": "Neurology" } ] } }, { "code": { "code": "focus", "system": "http://terminology.hl7.org/CodeSystem/usage-context-type" }, "valueCodeableConcept": { "coding": [ { "code": "diagnostic", "system": "https://fhir.nhs.uk/CodeSystem/reasonfortesting-genomics" } ] } } ],
goal
SHALL be present. For representing the modalities applicable for this test request (TBC)."goal": [ { "description": { "coding": [ { "code": "rare-disease-non-wgs", "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory", "display": "Rare Disease - Non-WGS" } ] } } ],
action
SHALL be present. Links to the tests under this test package."action": [ { "definitionCanonical": "http://fhir.nhs.uk/ActivityDefinition/GT1" } ]
StructureDefinition ActivityDefinition
FHIR representation for a DGTS Genomic Test. This is a definitional resource and available read-only from the DGTS FHIR API.
The below profile is provided to support parsing for clients if returned through a GET request.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/ActivityDefinition | HL7 International | trial-use |
| ActivityDefinition | C | DomainResource | Element idActivityDefinitionShort description The definition of a specific activity to be taken, independent of any particular patient or context DefinitionThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idActivityDefinition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idActivityDefinition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idActivityDefinition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idActivityDefinition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idActivityDefinition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idActivityDefinition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 0..1 | uri | Element idActivityDefinition.urlShort description Canonical identifier for this activity definition, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this activity definition 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 at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. Allows the activity definition to be referenced by a single globally unique identifier. 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. The 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. In 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 element to indicate where the current master source of the resource can be found. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idActivityDefinition.identifierShort description Additional identifier for the activity definition DefinitionA formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | Element idActivityDefinition.versionShort description Business version of the activity definition DefinitionThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. There may be different activity definition instances that have the same identifier 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 activity definition with the format [url]|[version]. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 0..1 | string | Element idActivityDefinition.nameShort description Name for this activity definition (computer friendly) DefinitionA natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. The cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints
| ||
| title | Σ | 0..1 | string | Element idActivityDefinition.titleShort description Name for this activity definition (human friendly) DefinitionA short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subtitle | 0..1 | string | Element idActivityDefinition.subtitleShort description Subordinate title of the activity definition DefinitionAn explanatory or alternate title for the activity definition giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| status | Σ ?! | 1..1 | codeBinding | Element idActivityDefinition.statusShort description draft | active | retired | unknown DefinitionThe status of this activity definition. Enables tracking the life-cycle of the content. Allows filtering of activity definitions that are appropriate for use versus not. The lifecycle status of an artifact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| experimental | Σ | 0..1 | boolean | Element idActivityDefinition.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition. Allows filtering of activity definitions that are appropriate for use versus not. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject[x] | 0..1 | Binding | Element idActivityDefinition.subject[x]Short description Type of individual the activity definition is intended for DefinitionA code or group definition that describes the intended subject of the activity being defined. Patient The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| subjectCodeableConcept | CodeableConcept | Data type | ||||
| subjectReference | Reference(Group) | Data type | ||||
| date | Σ | 0..1 | dateTime | Element idActivityDefinition.dateShort description Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the activity definition was published. 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 activity definition changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | Element idActivityDefinition.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the activity definition. Helps establish the "authority/credibility" of the activity definition. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. 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 activity definition. This item SHOULD be populated unless the information is available from context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | Element idActivityDefinition.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | Σ | 0..1 | markdown | Element idActivityDefinition.descriptionShort description Natural language description of the activity definition DefinitionA free text natural language description of the activity definition from a consumer's perspective. This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| useContext | Σ | 0..* | UsageContext | Element idActivityDefinition.useContextShort description The context that the content is intended to support DefinitionThe 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 activity definition instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | Element idActivityDefinition.jurisdictionShort description Intended jurisdiction for activity definition (if applicable) DefinitionA legal or geographic region in which the activity definition is intended to be used. It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..1 | markdown | Element idActivityDefinition.purposeShort description Why this activity definition is defined DefinitionExplanation of why this activity definition is needed and why it has been designed as it has. This element does not describe the usage of the activity definition. 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 activity definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| usage | 0..1 | string | Element idActivityDefinition.usageShort description Describes the clinical usage of the activity definition DefinitionA detailed description of how the activity definition is used from a clinical perspective. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| copyright | 0..1 | markdown | Element idActivityDefinition.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| approvalDate | 0..1 | date | Element idActivityDefinition.approvalDateShort description When the activity definition was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| lastReviewDate | 0..1 | date | Element idActivityDefinition.lastReviewDateShort description When the activity definition was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. If specified, this date follows the original approval date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectivePeriod | Σ C | 0..1 | Period | Element idActivityDefinition.effectivePeriodShort description When the activity definition is expected to be used DefinitionThe period during which the activity definition content was or is planned to be in active use. Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead. The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| topic | 0..* | CodeableConcept | Element idActivityDefinition.topicShort description E.g. Education, Treatment, Assessment, etc. DefinitionDescriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. High-level categorization of the definition, used for searching, sorting, and filtering. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | 0..* | ContactDetail | Element idActivityDefinition.authorShort description Who authored the content DefinitionAn individiual or organization primarily involved in the creation and maintenance of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| editor | 0..* | ContactDetail | Element idActivityDefinition.editorShort description Who edited the content DefinitionAn individual or organization primarily responsible for internal coherence of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reviewer | 0..* | ContactDetail | Element idActivityDefinition.reviewerShort description Who reviewed the content DefinitionAn individual or organization primarily responsible for review of some aspect of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endorser | 0..* | ContactDetail | Element idActivityDefinition.endorserShort description Who endorsed the content DefinitionAn individual or organization responsible for officially endorsing the content for use in some setting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relatedArtifact | 0..* | RelatedArtifact | Element idActivityDefinition.relatedArtifactShort description Additional documentation, citations, etc. DefinitionRelated artifacts such as additional documentation, justification, or bibliographic references. Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. Each related artifact is either an attachment, or a reference to another resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| library | 0..* | canonical(Library) | Element idActivityDefinition.libraryShort description Logic used by the activity definition DefinitionA reference to a Library resource containing any formal logic used by the activity definition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| kind | Σ | 0..1 | codeBinding | Element idActivityDefinition.kindShort description Kind of resource DefinitionA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. May determine what types of extensions are permitted. The kind of activity the definition is describing. RequestResourceType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | 0..1 | canonical(StructureDefinition) | Element idActivityDefinition.profileShort description What profile the resource needs to conform to DefinitionA profile to which the target of the activity definition is expected to conform. Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set. canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | Σ | 0..1 | CodeableConcept | Element idActivityDefinition.codeShort description Detail type of activity DefinitionDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Detailed type of the activity; e.g. CBC. ProcedureCodes(SNOMEDCT) (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | 0..1 | codeBinding | Element idActivityDefinition.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option DefinitionIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. Note that FHIR strings SHALL NOT exceed 1MB in size Codes indicating the degree of authority/intentionality associated with a request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| priority | 0..1 | codeBinding | Element idActivityDefinition.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the activity should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| doNotPerform | Σ ?! | 0..1 | boolean | Element idActivityDefinition.doNotPerformShort description True if the activity should not be performed DefinitionSet this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| timing[x] | 0..1 | Element idActivityDefinition.timing[x]Short description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| timingAge | Age | Data type | ||||
| timingDateTime | dateTime | Data type | ||||
| timingDuration | Duration | Data type | ||||
| timingPeriod | Period | Data type | ||||
| timingRange | Range | Data type | ||||
| timingTiming | Timing | Data type | ||||
| location | C | 0..1 | Reference(Location) | Element idActivityDefinition.locationShort description Where it should happen Alternate namesfacility DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Helps in planning of activity. May reference a specific clinical location or may just identify a type of location. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| participant | 0..* | BackboneElement | Element idActivityDefinition.participantShort description Who should participate in the action DefinitionIndicates who should participate in performing the action described. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idActivityDefinition.participant.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.participant.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.participant.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 1..1 | codeBinding | Element idActivityDefinition.participant.typeShort description patient | practitioner | related-person | device DefinitionThe type of participant in the action. Note that FHIR strings SHALL NOT exceed 1MB in size The type of participant in the activity. ActionParticipantType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| role | 0..1 | CodeableConcept | Element idActivityDefinition.participant.roleShort description E.g. Nurse, Surgeon, Parent, etc. DefinitionThe role the participant should play in performing the described action. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Defines roles played by participants for the action. ActionParticipantRole (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| product[x] | 0..1 | Element idActivityDefinition.product[x]Short description What's administered/supplied DefinitionIdentifies the food, drug or other product being consumed or supplied in the activity. Code describing the type of substance or medication. SNOMEDCTMedicationCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| productCodeableConcept | CodeableConcept | Data type | ||||
| productReference | Reference(Medication | Substance) | Data type | ||||
| quantity | C | 0..1 | SimpleQuantity | Element idActivityDefinition.quantityShort description How much is administered/consumed/supplied Alternate namesdose DefinitionIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| dosage | 0..* | Dosage | Element idActivityDefinition.dosageShort description Detailed dosage instructions DefinitionProvides detailed dosage instructions in the same way that they are described for MedicationRequest resources. If a dosage instruction is used, the definition should not specify timing or quantity. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| bodySite | 0..* | CodeableConcept | Element idActivityDefinition.bodySiteShort description What part of body to perform on DefinitionIndicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). Knowing where the procedure is made is important for tracking if multiple sites are possible. Only used if not implicit in the code found in ServiceRequest.type. A code that identifies the anatomical location. SNOMEDCTBodyStructures (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| specimenRequirement | C | 0..* | Reference(SpecimenDefinition) | Element idActivityDefinition.specimenRequirementShort description What specimens are required to perform this action DefinitionDefines specimen requirements for the action to be performed, such as required specimens for a lab test. Needed to represent lab order definitions. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| observationRequirement | C | 0..* | Reference(ObservationDefinition) | Element idActivityDefinition.observationRequirementShort description What observations are required to perform this action DefinitionDefines observation requirements for the action to be performed, such as body weight or surface area. Needed to represent observation definitions. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ObservationDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| observationResultRequirement | C | 0..* | Reference(ObservationDefinition) | Element idActivityDefinition.observationResultRequirementShort description What observations must be produced by this action DefinitionDefines the observations that are expected to be produced by the action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ObservationDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| transform | 0..1 | canonical(StructureMap) | Element idActivityDefinition.transformShort description Transform to apply the template DefinitionA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| dynamicValue | 0..* | BackboneElement | Element idActivityDefinition.dynamicValueShort description Dynamic aspects of the definition DefinitionDynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idActivityDefinition.dynamicValue.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.dynamicValue.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.dynamicValue.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| path | 1..1 | string | Element idActivityDefinition.dynamicValue.pathShort description The path to the element to be set dynamically DefinitionThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| expression | C | 1..1 | Expression | Element idActivityDefinition.dynamicValue.expressionShort description An expression that provides the dynamic value for the customization DefinitionAn expression specifying the value of the customized element. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Additional Guidance
- identifier
- title
- status
- experimental
- version
- useContext
- code
- library
- specimenRequirement
- relatedArtifact
identifier
SHALL be present. The DGTS test readable ID assigned to the test."identifier": [ { "system": "https://fhir.nhs.uk/Id/England-DigitalGenomicTestServices", "value": "GT1" }, { "system": "https://fhir.nhs.uk/Id/England-GenomicTestDirectory", "value": "R47.2", "use": "old" } ],
title
SHALL be present. The DGTS test name."title": "15q11 critical region (AS/PWS) - MLPA or equivalent",
status
SHALL be present. Used to represent the state of a test. Mapping of statuses which do not match the required HL7 ValueSet, e.g. "Deprecated", are pending investigation."status": "active",
experimental
SHALL be present. For representing whether a test/test package is in pre-release."experimental": false,
version
SHALL be present. The DGTS Test version."version": "1.0",
useContext
SHALL be present. Used for capturing the requesting reasons which are eligible for this test/test package"useContext": [ { "code": { "code": "focus", "system": "http://terminology.hl7.org/CodeSystem/usage-context-type" }, "valueCodeableConcept": { "coding": [ { "code": "diagnostic", "system": "https://fhir.nhs.uk/CodeSystem/reasonfortesting-genomics" } ] } } ],
code
SHALL be present. Used to represent the Test Method. Alignment with the HL7 method type list is under investigation."code": { "coding": [ { "code": "targeted-variant-analysis", "system": "http://hl7.org/fhir/genomicstudy-methodtype" } ] },
library
SHALL be present. A link to the data requirements for ordering this test."library": [ "http://fhir.nhs.uk/Library/GT1" ],
specimenRequirement
MAY be present. A reference to the specimen(s) expected for this test."specimenRequirement": [ { "reference": "SpecimenDefinition/DGTS-SpecimenDefinition-Example" } ],
relatedArtifact
MAY be present. Links to the GEL panels which could be included as part of this test (if marked as a GMS Rare Disease Virtual, can be added to the order as an additional panel)."relatedArtifact": [ { "type": "composed-of", "url": "https://panelapp.genomicsengland.co.uk/panels/1313", "label": "Carney complex", "display": "GMS Rare Disease" } ]
StructureDefinition Library
FHIR representation for the data requirements for a DGTS Genomic Test. This is a definitional resource and available read-only from the DGTS FHIR API.
The below profile is provided to support parsing for clients if returned through the $data-requirements operation on ActivityDefinition.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/Library | HL7 International | trial-use |
| Library | C | DomainResource | Element idLibraryShort description Represents a library of quality improvement components DefinitionThe Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLibrary.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLibrary.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLibrary.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLibrary.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idLibrary.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idLibrary.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idLibrary.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idLibrary.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | Σ | 0..1 | uri | Element idLibrary.urlShort description Canonical identifier for this library, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this library 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 at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers. Allows the library to be referenced by a single globally unique identifier. 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. The 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. In 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 element to indicate where the current master source of the resource can be found. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idLibrary.identifierShort description Additional identifier for the library DefinitionA formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this library outside of FHIR, where it is not possible to use the logical URI. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | Element idLibrary.versionShort description Business version of the library DefinitionThe identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. There may be different library instances that have the same identifier 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 library with the format [url]|[version]. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ C | 0..1 | string | Element idLibrary.nameShort description Name for this library (computer friendly) DefinitionA natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. The cardinality or value of this element may be affected by these constraints: ele-1, inv-0 Constraints
| ||
| title | Σ | 0..1 | string | Element idLibrary.titleShort description Name for this library (human friendly) DefinitionA short, descriptive, user-friendly title for the library. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subtitle | 0..1 | string | Element idLibrary.subtitleShort description Subordinate title of the library DefinitionAn explanatory or alternate title for the library giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| status | Σ ?! | 1..1 | codeBinding | Element idLibrary.statusShort description draft | active | retired | unknown DefinitionThe status of this library. Enables tracking the life-cycle of the content. Allows filtering of libraries that are appropriate for use vs. not. The lifecycle status of an artifact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| experimental | Σ | 0..1 | boolean | Element idLibrary.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level library. Allows filtering of librarys that are appropriate for use versus not. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | CodeableConceptBinding | Element idLibrary.typeShort description logic-library | model-definition | asset-collection | module-definition DefinitionIdentifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of knowledge asset this library contains. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject[x] | 0..1 | Binding | Element idLibrary.subject[x]Short description Type of individual the library content is focused on DefinitionA code or group definition that describes the intended subject of the contents of the library. Patient The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| subjectCodeableConcept | CodeableConcept | Data type | ||||
| subjectReference | Reference(Group) | Data type | ||||
| date | Σ | 0..1 | dateTime | Element idLibrary.dateShort description Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the library was published. 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 library changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | Element idLibrary.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the library. Helps establish the "authority/credibility" of the library. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. 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 library. This item SHOULD be populated unless the information is available from context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | Element idLibrary.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | Σ | 0..1 | markdown | Element idLibrary.descriptionShort description Natural language description of the library DefinitionA free text natural language description of the library from a consumer's perspective. This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| useContext | Σ | 0..* | UsageContext | Element idLibrary.useContextShort description The context that the content is intended to support DefinitionThe 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 library instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | Element idLibrary.jurisdictionShort description Intended jurisdiction for library (if applicable) DefinitionA legal or geographic region in which the library is intended to be used. It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..1 | markdown | Element idLibrary.purposeShort description Why this library is defined DefinitionExplanation of why this library is needed and why it has been designed as it has. This element does not describe the usage of the library. 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 library. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| usage | 0..1 | string | Element idLibrary.usageShort description Describes the clinical usage of the library DefinitionA detailed description of how the library is used from a clinical perspective. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| copyright | 0..1 | markdown | Element idLibrary.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library. Consumers must be able to determine any legal restrictions on the use of the library and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| approvalDate | 0..1 | date | Element idLibrary.approvalDateShort description When the library was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| lastReviewDate | 0..1 | date | Element idLibrary.lastReviewDateShort description When the library was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. If specified, this date follows the original approval date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectivePeriod | Σ C | 0..1 | Period | Element idLibrary.effectivePeriodShort description When the library is expected to be used DefinitionThe period during which the library content was or is planned to be in active use. Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the library are or are expected to be used instead. The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| topic | 0..* | CodeableConcept | Element idLibrary.topicShort description E.g. Education, Treatment, Assessment, etc. DefinitionDescriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching. Repositories must be able to determine how to categorize the library so that it can be found by topical searches. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. High-level categorization of the definition, used for searching, sorting, and filtering. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | 0..* | ContactDetail | Element idLibrary.authorShort description Who authored the content DefinitionAn individiual or organization primarily involved in the creation and maintenance of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| editor | 0..* | ContactDetail | Element idLibrary.editorShort description Who edited the content DefinitionAn individual or organization primarily responsible for internal coherence of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reviewer | 0..* | ContactDetail | Element idLibrary.reviewerShort description Who reviewed the content DefinitionAn individual or organization primarily responsible for review of some aspect of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endorser | 0..* | ContactDetail | Element idLibrary.endorserShort description Who endorsed the content DefinitionAn individual or organization responsible for officially endorsing the content for use in some setting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relatedArtifact | 0..* | RelatedArtifact | Element idLibrary.relatedArtifactShort description Additional documentation, citations, etc. DefinitionRelated artifacts such as additional documentation, justification, or bibliographic references. Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. Each related artifact is either an attachment, or a reference to another resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| parameter | 0..* | ParameterDefinition | Element idLibrary.parameterShort description Parameters defined by the library DefinitionThe parameter element defines parameters used by the library. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| dataRequirement | 0..* | DataRequirement | Element idLibrary.dataRequirementShort description What data is referenced by this library DefinitionDescribes a set of data that must be provided in order to be able to successfully perform the computations defined by the library. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| content | Σ C | 0..* | Attachment | Element idLibrary.contentShort description Contents of the library, either embedded or referenced DefinitionThe content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Additional Guidance
type
SHALL be present. Fixed value of `module-definition`."type": { "coding": [ { "code": "module-definition" } ] },
parameter
SHALL be present. Outlines the additional data requirements when ordering the test, indicated by the min/max values for each parameter.A min cardinality of 1 indicates the target element is required. A min cardinality of 0 indicates the target element is not required but can be optionally provided. A max cardinality of 0 indicates the target element should not be populated as part of an order.
"parameter": [ { "name": "additional_panels_available", "use": "in", "max": "0" "type": "Coding" }, { "name": "target_disease_required", "use": "in", "min": 0, "type": "Coding" }, { "name": "target_gene_required", "use": "in", "min": 0, "type": "Coding" }, { "name": "target_variant_required", "use": "in", "min": 0, "type": "Coding" } ]
StructureDefinition SpecimenDefinition
FHIR representation for the specimen requirements for a DGTS Genomic Test. This is a definitional resource and available read-only from the DGTS FHIR API.
The below profile is provided to support parsing for clients if returned through a GET request, following the reference from an ActivityDefinition.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/SpecimenDefinition | HL7 International | trial-use |
| SpecimenDefinition | C | DomainResource | Element idSpecimenDefinitionShort description Kind of specimen DefinitionA kind of specimen with associated set of requirements.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimenDefinition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSpecimenDefinition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSpecimenDefinition.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimenDefinition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idSpecimenDefinition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idSpecimenDefinition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..1 | Identifier | Element idSpecimenDefinition.identifierShort description Business identifier of a kind of specimen DefinitionA business identifier associated with the kind of specimen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| typeCollected | Σ | 0..1 | CodeableConcept | Element idSpecimenDefinition.typeCollectedShort description Kind of material to collect DefinitionThe kind of material to be collected. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of the specimen to be collected. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| patientPreparation | Σ | 0..* | CodeableConcept | Element idSpecimenDefinition.patientPreparationShort description Patient preparation for collection DefinitionPreparation of the patient for specimen collection. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Checks on the patient prior specimen collection. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| timeAspect | Σ | 0..1 | string | Element idSpecimenDefinition.timeAspectShort description Time aspect for collection DefinitionTime aspect of specimen collection (duration or offset). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 24 hour, 20' post chargeMappings
| ||
| collection | Σ | 0..* | CodeableConcept | Element idSpecimenDefinition.collectionShort description Specimen collection procedure DefinitionThe action to be performed for collecting the specimen. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The action to collect a type of specimen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| typeTested | 0..* | BackboneElement | Element idSpecimenDefinition.typeTestedShort description Specimen in container intended for testing by lab DefinitionSpecimen conditioned in a container as expected by the testing laboratory. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| isDerived | 0..1 | boolean | Element idSpecimenDefinition.typeTested.isDerivedShort description Primary or secondary specimen DefinitionPrimary of secondary specimen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General falseMappings
| |||
| type | 0..1 | CodeableConcept | Element idSpecimenDefinition.typeTested.typeShort description Type of intended specimen DefinitionThe kind of specimen conditioned for testing expected by lab. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of specimen conditioned in a container for lab testing. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| preference | 1..1 | codeBinding | Element idSpecimenDefinition.typeTested.preferenceShort description preferred | alternate DefinitionThe preference for this type of conditioned specimen. Note that FHIR strings SHALL NOT exceed 1MB in size Degree of preference of a type of conditioned specimen. SpecimenContainedPreference (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General preferred, alternateMappings
| |||
| container | 0..1 | BackboneElement | Element idSpecimenDefinition.typeTested.containerShort description The specimen's container DefinitionThe specimen's container. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.container.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.container.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.container.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| material | 0..1 | CodeableConcept | Element idSpecimenDefinition.typeTested.container.materialShort description Container material DefinitionThe type of material of the container. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Types of material for specimen containers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | 0..1 | CodeableConcept | Element idSpecimenDefinition.typeTested.container.typeShort description Kind of container associated with the kind of specimen DefinitionThe type of container used to contain this kind of specimen. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Type of specimen container. SpecimenContainerType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| cap | 0..1 | CodeableConcept | Element idSpecimenDefinition.typeTested.container.capShort description Color of container cap DefinitionColor of container cap. From ISO 6710-2017 Table F.1 Recommended colour codes. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Color of the container cap. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| description | 0..1 | string | Element idSpecimenDefinition.typeTested.container.descriptionShort description Container description DefinitionThe textual description of the kind of container. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General Blue top tube with citrateMappings
| |||
| capacity | C | 0..1 | SimpleQuantity | Element idSpecimenDefinition.typeTested.container.capacityShort description Container capacity DefinitionThe capacity (volume or other measure) of this kind of container. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| minimumVolume[x] | 0..1 | Element idSpecimenDefinition.typeTested.container.minimumVolume[x]Short description Minimum volume DefinitionThe minimum volume to be conditioned in the container. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| minimumVolumeQuantity | SimpleQuantity | Data type | ||||
| minimumVolumeString | string | Data type | ||||
| additive | 0..* | BackboneElement | Element idSpecimenDefinition.typeTested.container.additiveShort description Additive associated with container DefinitionSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.container.additive.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.container.additive.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.container.additive.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| additive[x] | 1..1 | Element idSpecimenDefinition.typeTested.container.additive.additive[x]Short description Additive associated with container DefinitionSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Substance added to specimen container. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| additiveCodeableConcept | CodeableConcept | Data type | ||||
| additiveReference | Reference(Substance) | Data type | ||||
| preparation | 0..1 | string | Element idSpecimenDefinition.typeTested.container.preparationShort description Specimen container preparation DefinitionSpecial processing that should be applied to the container for this kind of specimen. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| requirement | 0..1 | string | Element idSpecimenDefinition.typeTested.requirementShort description Specimen requirements DefinitionRequirements for delivery and special handling of this kind of conditioned specimen. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| retentionTime | C | 0..1 | Duration | Element idSpecimenDefinition.typeTested.retentionTimeShort description Specimen retention time DefinitionThe usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| rejectionCriterion | 0..* | CodeableConcept | Element idSpecimenDefinition.typeTested.rejectionCriterionShort description Rejection criterion DefinitionCriterion for rejection of the specimen in its container by the laboratory. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Criterion for rejection of the specimen by laboratory. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| handling | 0..* | BackboneElement | Element idSpecimenDefinition.typeTested.handlingShort description Specimen handling before testing DefinitionSet of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.handling.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.handling.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimenDefinition.typeTested.handling.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| temperatureQualifier | 0..1 | CodeableConcept | Element idSpecimenDefinition.typeTested.handling.temperatureQualifierShort description Temperature qualifier DefinitionIt qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Set of handling instructions prior testing of the specimen. HandlingConditionSet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| temperatureRange | C | 0..1 | Range | Element idSpecimenDefinition.typeTested.handling.temperatureRangeShort description Temperature range DefinitionThe temperature interval for this set of handling instructions. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| maxDuration | C | 0..1 | Duration | Element idSpecimenDefinition.typeTested.handling.maxDurationShort description Maximum preservation time DefinitionThe maximum time interval of preservation of the specimen with these conditions. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instruction | 0..1 | string | Element idSpecimenDefinition.typeTested.handling.instructionShort description Preservation instruction DefinitionAdditional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General freeze within 4 hoursMappings
|
Additional Guidance
typeCollected
SHALL be present. Represents the origin of the specimen, e.g. germline/somatic."typeCollected": { "coding": [ { "code": "germline", "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-SampleCategory" } ] },
typeTested
SHALL be present. Outlines the specimen type and state expected as well as whether the type os preferred or expected. Alignment of specimen types to SNOMED CT and states to the HL7 additive/preparation code lists is pending investigation."typeTested": [ { "type": { "coding": [ { "code": "119297000", "system": "http://snomed.info/sct", "display": "Blood specimen" } ] }, "preference": "preferred", "container": { "additive": [ { "additiveCodeableConcept" [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0371", "code": "EDTK15", "display": "Potassium/K EDTA 15%" } ] } ] } } ]