This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
SD.37 StructureDefinition-specimen-uv-ips
This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary
Conformance resource variables defined here
SD.37.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/specimen-uv-ips
Published on Fri Mar 09 00:00:00 AEDT 2018 as a draft by HL7 International.
This profile builds on Specimen
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Specimen | I | 0..* | Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
  id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
 meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
 contained | 0..* | Resource | Contained, inline Resources | |
| identifier | ΣI | 0..* | Identifier | External Identifier ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
 userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General': http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General': 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
 assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| accessionIdentifier | ΣI | 0..1 | Identifier | Identifier assigned by the lab ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General': http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General': 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| status | ?!ΣI | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: http://hl7.org/ips/fhir/ValueSet/specimen-type (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| subject | ΣI | 1..1 | Reference(Patient) | Where the specimen came from. This may be from the patient(s) or from the environment or a device ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| collection | I | 0..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 collected[x] | ΣI | 0..1 | dateTime, Period | Collection time ele-1: All FHIR elements must have a @value or children |
| method | I | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system Binding: http://trilliumbridge.eu/fhir/ValueSet/specimen-collection-method (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| bodySite | I | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system Binding: SNOMED CT Body Structures (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| note | I | 0..* | Annotation | Comments ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| author[x] | ΣI | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| time | ΣI | 0..1 | dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
| text | I | 1..1 | string | The annotation - text content ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
