STARS Implementation Guide
0.3.0 - ci-build
This page is part of the Csiro Stars (v0.3.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
Within FHIR sending specimen from a client to a destination laboratory for testing is known as a ServiceRequest. Changes have been made to the standard R5 ServiceRequest Profile to better accomodate our individual situation and testing arrangements. You can view the details regarding the customised profile here CsiroStarsServiceRequestProfile.
Below is the field list as specified for the CSV file format. All required fields MUST be present within each row of the file.
| Name (Required) | Definition | Value |
|---|---|---|
| messageheader_event | See MessageHeader.id CsiroStarsMessageHeaderProfile | Message type: Must be "ServiceRequest" for sending specimen ValueSet: MessageTypeValueSet |
| messageheader_receiver | See MessageHeader.destination.receiver CsiroStarsMessageHeaderProfile | node username |
| messageheader_sender | See MessageHeader.sender CsiroStarsMessageHeaderProfile | node username or senders username |
| messageheader_author_identifier | See MessageHeader.author CsiroStarsMessageHeaderProfile -> See Practitioner.identifier CsiroStarsPractitionerProfile | stars username |
| messageheader_author_fullname | See MessageHeader.author CsiroStarsMessageHeaderProfile -> See Practitioner.name CsiroStarsPractitionerProfile | Free-text |
| messageheader_author_email | See MessageHeader.author CsiroStarsMessageHeaderProfile -> See Practitioner.identifier CsiroStarsPractitionerProfile | Free-text |
| servicerequest_submissioncategory | Submission category to highlight the importance of a submission. See ServiceRequest.submissionCategory CsiroStarsServiceRequestProfile | ValueSet: SubmissionCategoryValueSet |
| servicerequest_requisition | Submitters job or case reference. See ServiceRequest.Requisition CsiroStarsServiceRequestProfile | Free-text |
| servicerequest_status | See ServiceRequest.status CsiroStarsServiceRequestProfile | ValueSet: RequestStatusValueSet |
| servicerequest_intent | See ServiceRequest.intent CsiroStarsServiceRequestProfile | ValueSet: [RequestIntentValueSet] |
| servicerequest_authoredon | See ServiceRequest.authoredOn CsiroStarsServiceRequestProfile | DateTime |
| servicerequest_requester_fullname | See ServiceRequest.requester CsiroStarsServiceRequestProfile | Free-text |
| servicerequest_requester_email | See ServiceRequest.requester CsiroStarsServiceRequestProfile | Free-text |
| servicerequest_reason | See ServiceRequest.reasonReference CsiroStarsServiceRequestProfile | Free-text |
| patient_identifier | See Patient.identifier CsiroStarsPatientProfile | Free-text |
| patient_ishuman | See Patient.isHuman IsHuman | Boolean |
| patient_owner_name | See Patient.link.other.name.text CsiroStarsRelatedPersonProfile | Free-text |
| patient_owner_address_line1 | See Patient.link.other.address.line CsiroStarsRelatedPersonProfile | Free-text |
| patient_owner_address_city | See Patient.link.other.address.city CsiroStarsRelatedPersonProfile | Free-text |
| patient_owner_address_state | See Patient.link.other.address.state CsiroStarsRelatedPersonProfile | ValueSet: PropertyStateValueSet |
| patient_owner_address_postcode | See Patient.link.other.address.postalCode CsiroStarsRelatedPersonProfile | Free-text |
| patient_owner_address_country | See Patient.link.other.address.country CsiroStarsRelatedPersonProfile | ValueSet: PropertyCountryValueSet |
| specimen_identifier | See Specimen.accessionIdentifier CsiroStarsSpecimenProfile | Free-text |
| specimen_type | See Specimen.type CsiroStarsSpecimenProfile | ValueSet: SpecimenTypeValueSet |
| specimen_condition | See Specimen.condition CsiroStarsSpecimenProfile | ValueSet: SamplePresentationValueSet |
| specimen_collecteddatetime | See Specimen.collection.collectedDateTime CsiroStarsSpecimenProfile | DateTime |
| specimen_processing | See Specimen.processing CsiroStarsSpecimenProfile | Free-text |
| specimen_note | See Specimen.note CsiroStarsSpecimenProfile | Free-text |
| Name (Optional) | Definition | Value |
|---|---|---|
| messageheader_id | Message Identifier: UUID | Free-text (UUID) |
| servicerequest_priority | See ServiceRequest.priority CsiroStarsServiceRequestProfile | ValueSet: [RequestPriorityValueSet] |
| servicerequest_reportcopy_emails | A list of email addresses separated by ; that copies of the report will also be sent to. |
Free-text |
| servicerequest_supportinginfo | See ServiceRequest.supportingInfo [CsiroStarsObservationSupportingInfoProfile] | Free-text |
| patient_microchipnumber | See Patient.identifier CsiroStarsPatientProfile as identifier.type = MCN | Free-text |
| patient_name | See Patient.name.text CsiroStarsPatientProfile | Free-text |
| patient_age | See Patient.age PatientAge | Free-text plus ValueSet: [AgeValueSet] |
| patient_agegrouping | See Patient.ageGrouping PatientAgeGrouping | Free-text |
| patient_gender | See Patient.gender AdministrativeGenderValueSet | ValueSet: [AdministrativeGenderValueSet] |
| patient_genderstatus | See Patient.animal.genderStatus CsiroStarsPatientAnimalProfile | ValueSet: [GenderStatusValueSet] |
| patient_species | See Patient.animal.species CsiroStarsPatientAnimalProfile | ValueSet: SpeciesValueSet |
| patient_breed | See Patient.animal.breed CsiroStarsPatientAnimalProfile | Free-text |
| patient_owner_address_line2 | Free-text | |
| patient_owner_address_district | Free-text | |
| specimen_location_address_line1 | See Specimen.collection.location.address.line SpecimenCollectionLocation | Free-text |
| specimen_location_address_line2 | See Specimen.collection.location.address.line SpecimenCollectionLocation | Free-text |
| specimen_location_address_city | See Specimen.collection.location.address.city SpecimenCollectionLocation | Free-text |
| specimen_location_address_district | See Specimen.collection.location.address.district SpecimenCollectionLocation | Free-text |
| specimen_location_address_state | See Specimen.collection.location.address.state SpecimenCollectionLocation | Free-text |
| specimen_location_address_postcode | See Specimen.collection.location.address.postalCode SpecimenCollectionLocation | Free-text |
| specimen_location_address_country | See Specimen.collection.location.address.country SpecimenCollectionLocation | ValueSet: PropertyCountryValueSet |
| specimen_location_pic | See Specimen.collection.location.propertyIdentificationCode SpecimenCollectionLocation | Free-text |
| specimen_location_gps_longitude | See Specimen.collection.location.position.longitude SpecimenCollectionLocation | Free-text |
| specimen_location_gps_latitude | See Specimen.collection.location.position.latitude SpecimenCollectionLocation | Free-text |
| New Field | Old Field |
|---|---|
| messageheader_id | MESSAGE.STARS_ID |
| messageheader_event | MESSAGE.MESSAGE_TYPE |
| messageheader_receiver | MESSAGE.DEST_NODE |
| messageheader_sender | MESSAGE.SOURCE_NODE |
| messageheader_author_identifier | MESSAGE.USER_ID |
| messageheader_author_fullname | (new) |
| messageheader_author_email | MESSAGE.EMAIL |
| servicerequest_submissioncategory | JOB.SUBMISSION_CAT |
| servicerequest_requisition | JOB.CUST_JOB_REF |
| servicerequest_status | JOB.JOB_STATUS |
| servicerequest_intent | (new) |
| servicerequest_authoredon | MESSAGE.DATE_SENT |
| servicerequest_priority | (new) |
| servicerequest_requester_fullname | JOB.CONTACT_NAME |
| servicerequest_requester_email | (new) |
| servicerequest_reportcopy_emails | JOB.COPY_TO |
| servicerequest_reason | JOB.EXAM_REQUESTED |
| servicerequest_supportinginfo | JOB.CLINICAL_HISTORY |
| patient_identifier | SAMPLE.CUST_JOB_SAMP_REF |
| patient_microchipnumber | (new) |
| patient_name | SAMPLE.CUST_JOB_SAMP_NAME |
| patient_age | SAMPLE.AGE + SAMPLE.AGE_UNITS |
| patient_agegrouping | SAMPLE.AGE_GROUP |
| patient_ishuman | (new) |
| patient_gender | SAMPLE.SEX (split with genderstatus) |
| patient_genderstatus | SAMPLE.SEX (split with gender) |
| patient_species | SAMPLE.SPECIES |
| patient_breed | SAMPLE.SPECIES_BREED |
| patient_owner_name | JOB.OWNER |
| patient_owner_address_line1 | JOB.PROPERTY_ADDRESS |
| patient_owner_address_line2 | JOB.PROPERTY_ADDRESS |
| patient_owner_address_city | JOB.PROPERTY_TOWN_CITY |
| patient_owner_address_district | (new) |
| patient_owner_address_state | JOB.PROPERTY_STATE |
| patient_owner_address_postcode | JOB.PROPERTY_POSTCODE |
| patient_owner_address_country | JOB.PROPERTY_COUNTRY |
| specimen_identifier | SAMPLE.STARS_SAMPLE_ID |
| specimen_type | SAMPLE.SAMPLE_TYPE |
| specimen_condition | (new) |
| specimen_collecteddatetime | SAMPLE.DATE_COLLECTED |
| specimen_processing | SAMPLE.SAMPLE_PRESENTATION |
| specimen_note | JOB.SAMPLE_INFO |
| specimen_location_address_line1 | (new) |
| specimen_location_address_line2 | (new) |
| specimen_location_address_city | (new) |
| specimen_location_address_district | (new) |
| specimen_location_address_state | (new) |
| specimen_location_address_postcode | (new) |
| specimen_location_address_country | (new) |
| specimen_location_address_pic | (new) |
| specimen_location_address_gps_longitude | JOB.GPS_LONGITUDE |
| specimen_location_address_gps_latitude | JOB.GPS_LATITUDE |
This data structure is used internally as an intermediary format when converting between CSV and FHIR messages and may help to understand the structure of the complete FHIR Profiles. See the Artifact Profile List for more detailed information.