--- schema_version: "1" id: b6c15fcedae30a21d816646e174df4314d9a1f338ca411875416ecb0b19c5ec8 title: DiagnosticSummary collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/hc_r4_api_objects_DiagnosticSummary.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_DiagnosticSummary.htm source_site: developer.salesforce.com content_type: documentation content_hash: 12b0fd5453398f1fd5ea0c77df111640760a1aa1d678f63db285f729f1293c61 description: Represents the findings, interpretations, and summaries of tests performed on patients. This object is available in API version 51.0 and later. --- # DiagnosticSummary Represents the findings, interpretations, and summaries of tests performed on patients. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Information for DiagnosticSummary in Other Objects In addition to creating a record using these fields, you can add more details to your DiagnosticSummary record by creating records in certain other objects, and referencing your DiagnosticSummary record as the parent record. Here’s the list of objects you can associate to DiagnosticSummary in this way, the type of information they add, and the field they use to reference DiagnosticSummary. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the diagnostic summary. | ParentRecordId | | DiagnosticSummaryDetail | Associates document reference-type DiagnosticSummary records with various other records and defines the nature of association. For instance, authors, related documents, and related encounters. | DiagnosticSummaryId | - **[DiagnosticSummaryDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_diagnosticsummarydetail.htm)** Represents additional information associated with document reference-type DiagnosticSummary records. This additional information may be related documents, authors, or related encounters. This object is available in API version 52.0 and later. ## Fields ### AttachmentLanguage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Records the language of the attached document. ### AuthenticatorId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or organization that authenticates the validity of the document. - **Referenced Objects**: - Account - Contact - HealthcareProvider - User ### BasedOnId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the care plan, medication request, medication statement, or clinical service request that the diagnostic summary is based on. - **Referenced Objects**: - CarePlan - ClinicalServiceRequest - MedicationRequest - MedicationStatement ### CareObservationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the care observation that’s a part of the diagnostic summary. - **Referenced Objects**: - CareObservation ### Category - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the category of the department or service that the diagnostic summary is a product of. - **Possible values**: - Community - Inpatient - Outpatient - Patient Specified ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the encounter that the diagnostic summary is about. - **Referenced Objects**: - ClinicalEncounter ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that describes the diagnostic summary. - **Referenced Objects**: - CodeSetBundle ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the diagnostic summary. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The content document associated with diagnostic summary. You can include up to 5 documents in the PDF format. This field is available in API version 62.0 and later. This field is a relationship field. - **Referenced Objects**: - ContentDocument ### CustodianId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or organization that's responsible for the document's maintenance and access. - **Referenced Objects**: - Account ### DocumentFormatCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the document's encoding, structure, and template. - **Referenced Objects**: - CodeSet ### DocumentSecurityCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the document's security or privacy level. - **Referenced Objects**: - CodeSetBundle ### DocumentStage - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the stage of verification or completion of the document. - **Possible values**: - Preliminary - Final - Amended - Entered-in-Error ### DocumentTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the specific type of the document. - **Referenced Objects**: - CodeSetBundle ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the clinically relevant period of the summary. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the clinically relevant period of the summary. ### ImageComments1 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the first image linked in the report. ### ImageComments2 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the second image linked in the report. ### ImageComments3 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the third image linked in the report. ### ImageComments4 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the fourth image linked in the report. ### ImageComments5 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the fifth image linked in the report. ### ImageUrl1 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl2 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl3 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl4 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl5 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### InterpretedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the person or organization responsible for interpreting the diagnostic summary and its conclusions. - **Referenced Objects**: - CarePerformer ### IssuedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care performer that issues the diagnostic summary. - **Referenced Objects**: - CarePerformer ### IssuedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the diagnostic summary was issued. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the diagnostic summary record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the diagnostic summary record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the patient who is the subject of the diagnostic summary. - **Referenced Objects**: - Account ### PrimaryProviderId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the primary provider associated with the diagnostic summary. - **Referenced Objects**: - Account - Contact - HealthcareProvider ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the diagnostic summary. - **Possible values**: - Active - Completed - Entered-in-error - Intended - Not-taken - On-hold - Stopped - Unknown ### Summary - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical conclusion of the tests performed in the diagnostic service. ### SummaryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the clinical conclusion of the tests as reported in the diagnostic service. - **Referenced Objects**: - CodeSetBundle ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the information in the record represents a diagnostic summary or a document reference. - **Possible values**: - DiagnosticSummary—Diagnostic Summary - DocumentReference—Document Reference ## Usage DiagnosticSummary is used to store records representing both DiagnosticReport and DocumentReference type information from FHIR-based systems. You can use the UsageType field to specify which records represent diagnostic reports and which records represent document references. For document reference records, you can also use the DiagnosticSummaryDetail child object to associate authors, related documents, and related encounters to your DiagnosticSummary record. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [DiagnosticSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [DiagnosticSummaryFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DiagnosticSummaryHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DiagnosticSummaryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [DiagnosticSummaryShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object.