FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Query
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
API
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
Tools
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
Project CASIDE
Cancer Screening Profile
Tests performed to detect cancer before symptoms appear or to confirm a suspected diagnosis, such as laboratory tests or medical imaging. The goal of cancer screening is to provide useful health information which can guide medical treatment.
- type Profile on Procedure
- FHIR R4
- status Draft
-
version1.0
Missing canonical claim
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| CASIDECancerScreening (Procedure) | I | Procedure | There are no (further) constraints on this element Element idProcedure 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.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idProcedure.meta 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idProcedure.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idProcedure.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idProcedure.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idProcedure.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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.
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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.
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idProcedure.identifier 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.
|
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | There are no (further) constraints on this element Element idProcedure.instantiatesCanonical 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(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Constraints
|
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idProcedure.instantiatesUri 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.
|
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | There are no (further) constraints on this element Element idProcedure.basedOn A request for this procedure Alternate namesfulfills DefinitionA reference to a resource that contains details of the request for this procedure. Reference(CarePlan | ServiceRequest) Constraints
|
| partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | There are no (further) constraints on this element Element idProcedure.partOf 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(Procedure | Observation | MedicationAdministration) Constraints
|
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idProcedure.status preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown 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.
|
| statusReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.statusReason 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.
|
| category | Σ | 1..1 | CodeableConceptPattern | Element idProcedure.category Classification of the procedure DefinitionA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). A code that classifies a procedure for searching, sorting and display purposes.
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "15886004"
}
]
}
|
| code | Σ | 1..1 | CodeableConceptPattern | Element idProcedure.code Identification of the procedure 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. A code to identify a specific procedure .
{
"coding": [
{
"system": "http://snomed.info/sct"
}
]
}
|
| subject | Σ | 1..1 | Reference(Cancer Survivor Profile) | Element idProcedure.subject Who the procedure was performed on Alternate namespatient DefinitionThe person, animal or group on which the procedure was performed. Reference(Cancer Survivor Profile) Constraints
|
| encounter | Σ | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idProcedure.encounter 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.
|
| performed[x] | Σ | 0..1 | There are no (further) constraints on this element Element idProcedure.performed[x] 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.
| |
| performedDateTime | dateTime | Data type | ||
| performedPeriod | Period | Data type | ||
| recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idProcedure.recorder Who recorded the procedure DefinitionIndividual who recorded the record and takes responsibility for its content. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Constraints
|
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idProcedure.asserter Person who asserts this procedure DefinitionIndividual who is making the procedure statement. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Constraints
|
| performer | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idProcedure.performer The people who performed the procedure DefinitionLimited to "real" people rather than equipment.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idProcedure.performer.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.performer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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.
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.performer.modifierExtension 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.
|
| function | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.performer.function 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. A code that identifies the role of a performer of the procedure.
|
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | There are no (further) constraints on this element Element idProcedure.performer.actor The reference to the practitioner DefinitionThe practitioner who was involved in the procedure. A reference to Device supports use cases, such as pacemakers. Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Constraints
|
| onBehalfOf | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idProcedure.performer.onBehalfOf 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.
| |
| location | Σ | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idProcedure.location 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.
|
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.reasonCode 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.
|
| reasonReference | Σ | 0..* | Reference(Cancer Disease Profile) | Element idProcedure.reasonReference 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(Cancer Disease Profile) Constraints
|
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idProcedure.bodySite 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. http://gradiant.org/fhir/ValueSet/CASIDEBodyStructureVS
|
| outcome | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idProcedure.outcome 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.
|
| report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | There are no (further) constraints on this element Element idProcedure.report 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(DiagnosticReport | DocumentReference | Composition) Constraints
| |
| complication | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.complication 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. Codes describing complications that resulted from a procedure.
| |
| complicationDetail | 0..* | Reference(Condition) | There are no (further) constraints on this element Element idProcedure.complicationDetail 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.
| |
| followUp | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.followUp 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. Specific follow up required for a procedure e.g. removal of sutures.
| |
| note | 0..* | Annotation | There are no (further) constraints on this element Element idProcedure.note Additional information about the procedure DefinitionAny other notes and comments about the procedure.
| |
| focalDevice | 0..* | BackboneElement | There are no (further) constraints on this element Element idProcedure.focalDevice 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idProcedure.focalDevice.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.focalDevice.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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.
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idProcedure.focalDevice.modifierExtension 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.
|
| action | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idProcedure.focalDevice.action Kind of change to device DefinitionThe kind of change that happened to the device during the procedure. A kind of change that happened to the device during the procedure.
| |
| manipulated | 1..1 | Reference(Device) | There are no (further) constraints on this element Element idProcedure.focalDevice.manipulated Device that was changed DefinitionThe device that was manipulated (changed) during the procedure.
| |
| usedReference | 0..* | Reference(Device | Medication | Substance) | There are no (further) constraints on this element Element idProcedure.usedReference 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) Constraints
| |
| usedCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idProcedure.usedCode 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.
|
Documentation:
https://simplifier.net/caside/casidecancerscreening
Last updated on