{
"description": "These are letter templates, they need to be searchable by type, category, product type, submission type and review path",
"_filename": "DOCUMENT-REFERENCE-LETTER-TEMPLATE.json",
"package_name": "ca.on.health.idms.agreementmvp",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "5.0.0",
"name": "IDMSDocumentLetterTemplate",
"abstract": false,
"type": "DocumentReference",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "IDMS - DocumentReference - Letter Template",
"package_version": "3.0.2",
"status": "active",
"id": "e403da2d-2e22-4460-b32a-74ca801039c8",
"kind": "resource",
"url": "https://health.gov.on.ca/idms/fhir/StructureDefinition/IDMS-DocumentReference-Letter-Template",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "DocumentReference.identifier",
"min": 1,
"path": "DocumentReference.identifier",
"short": "Template Identifier",
"definition": "#### **_`IDMS: This is the template's unique identifier. When a letter is generated this identfier is saved with the letter (see DocumentReference.content.profile.valueURI) so we can trace back which template was used.`_**"
}, {
"id": "DocumentReference.identifier.extension",
"max": "0",
"path": "DocumentReference.identifier.extension"
}, {
"id": "DocumentReference.identifier.use",
"max": "0",
"path": "DocumentReference.identifier.use"
}, {
"id": "DocumentReference.identifier.type",
"max": "0",
"path": "DocumentReference.identifier.type"
}, {
"id": "DocumentReference.identifier.type.coding.system",
"min": 1,
"path": "DocumentReference.identifier.type.coding.system"
}, {
"id": "DocumentReference.identifier.type.coding.code",
"min": 1,
"path": "DocumentReference.identifier.type.coding.code"
}, {
"id": "DocumentReference.identifier.type.coding.display",
"min": 1,
"path": "DocumentReference.identifier.type.coding.display"
}, {
"id": "DocumentReference.identifier.system",
"min": 1,
"path": "DocumentReference.identifier.system",
"short": "Primary File Number System",
"fixedUri": "urn:idms:letter:template",
"definition": "IDMS's Primary File Number System"
}, {
"id": "DocumentReference.identifier.value",
"min": 1,
"path": "DocumentReference.identifier.value",
"short": "Primary File Number",
"definition": "#### **_`IDMS: Letter template unique identifier. Format urn:idms:template + template name + .v + version number `_**"
}, {
"id": "DocumentReference.identifier.period",
"max": "0",
"path": "DocumentReference.identifier.period"
}, {
"id": "DocumentReference.identifier.assigner",
"max": "0",
"path": "DocumentReference.identifier.assigner"
}, {
"id": "DocumentReference.version",
"max": "0",
"path": "DocumentReference.version"
}, {
"id": "DocumentReference.basedOn",
"max": "0",
"path": "DocumentReference.basedOn"
}, {
"id": "DocumentReference.status",
"path": "DocumentReference.status",
"definition": "#### **_`IDMS: This is mandatory according to FHIR, it will always be 'current'.`_**"
}, {
"id": "DocumentReference.docStatus",
"max": "0",
"path": "DocumentReference.docStatus"
}, {
"id": "DocumentReference.modality",
"max": "0",
"path": "DocumentReference.modality"
}, {
"id": "DocumentReference.type",
"min": 1,
"path": "DocumentReference.type",
"definition": "#### **_`IDMS: This is the Letter Template Type. Example 'NDSS - Complete'.`_**"
}, {
"id": "DocumentReference.type.extension",
"max": "0",
"path": "DocumentReference.type.extension"
}, {
"id": "DocumentReference.type.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.type.coding"
}, {
"id": "DocumentReference.type.coding.extension",
"max": "0",
"path": "DocumentReference.type.coding.extension"
}, {
"id": "DocumentReference.type.coding.system",
"min": 1,
"path": "DocumentReference.type.coding.system",
"fixedUri": "https://health.gov.on.ca/idms/fhir/CodeSystem/IDMS-Internal"
}, {
"id": "DocumentReference.type.coding.version",
"max": "0",
"path": "DocumentReference.type.coding.version"
}, {
"id": "DocumentReference.type.coding.code",
"min": 1,
"path": "DocumentReference.type.coding.code",
"binding": {
"strength": "required",
"valueSet": "https://health.gov.on.ca/idms/fhir/ValueSet/IDMS-DocumentReference-Letter-Types"
}
}, {
"id": "DocumentReference.type.coding.display",
"path": "DocumentReference.type.coding.display"
}, {
"id": "DocumentReference.type.coding.userSelected",
"max": "0",
"path": "DocumentReference.type.coding.userSelected"
}, {
"id": "DocumentReference.type.text",
"max": "0",
"path": "DocumentReference.type.text"
}, {
"id": "DocumentReference.category",
"max": "4",
"path": "DocumentReference.category",
"short": "Classifications of the Letter Template",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.version",
"type": "value"
} ]
},
"definition": "#### **_`IDMS: Category, Product Type , Submission Type , Generic Type .`_**"
}, {
"id": "DocumentReference.category:RequestCategory",
"max": "1",
"path": "DocumentReference.category",
"sliceName": "RequestCategory"
}, {
"id": "DocumentReference.category:RequestCategory.extension",
"max": "0",
"path": "DocumentReference.category.extension"
}, {
"id": "DocumentReference.category:RequestCategory.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.category.coding"
}, {
"id": "DocumentReference.category:RequestCategory.coding.extension",
"max": "0",
"path": "DocumentReference.category.coding.extension"
}, {
"id": "DocumentReference.category:RequestCategory.coding.system",
"min": 1,
"path": "DocumentReference.category.coding.system",
"fixedUri": "https://health.gov.on.ca/idms/fhir/CodeSystem/Internal-Request-Category-Types"
}, {
"id": "DocumentReference.category:RequestCategory.coding.version",
"max": "0",
"path": "DocumentReference.category.coding.version"
}, {
"id": "DocumentReference.category:RequestCategory.coding.code",
"min": 1,
"path": "DocumentReference.category.coding.code",
"binding": {
"strength": "required",
"valueSet": "https://health.gov.on.ca/idms/fhir/ValueSet/Request-Category",
"description": "Request Category"
}
}, {
"id": "DocumentReference.category:RequestCategory.coding.display",
"min": 1,
"path": "DocumentReference.category.coding.display"
}, {
"id": "DocumentReference.category:RequestCategory.coding.userSelected",
"max": "0",
"path": "DocumentReference.category.coding.userSelected"
}, {
"id": "DocumentReference.category:RequestCategory.text",
"max": "0",
"path": "DocumentReference.category.text",
"short": "Distinquishes this as the ProductType Code, has a fixed value of 'ProductType'",
"fixedString": "RequestCategory"
}, {
"id": "DocumentReference.category:ProductType",
"max": "1",
"path": "DocumentReference.category",
"sliceName": "ProductType"
}, {
"id": "DocumentReference.category:ProductType.extension",
"max": "0",
"path": "DocumentReference.category.extension"
}, {
"id": "DocumentReference.category:ProductType.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.category.coding"
}, {
"id": "DocumentReference.category:ProductType.coding.extension",
"max": "0",
"path": "DocumentReference.category.coding.extension"
}, {
"id": "DocumentReference.category:ProductType.coding.system",
"min": 1,
"path": "DocumentReference.category.coding.system",
"short": "IDMS Product Submission Code System",
"fixedUri": "https://health.gov.on.ca/idms/fhir/CodeSystem/Internal-Product-Types"
}, {
"id": "DocumentReference.category:ProductType.coding.version",
"max": "0",
"path": "DocumentReference.category.coding.version",
"short": "Type of Code",
"definition": "This being used as the discriminator, it is the type of code. (The version of the code system is not relevant in IDMS so this is being reused)",
"fixedString": "ProductType"
}, {
"id": "DocumentReference.category:ProductType.coding.code",
"min": 1,
"path": "DocumentReference.category.coding.code",
"short": "This is the Product Type Code",
"binding": {
"strength": "required",
"valueSet": "https://health.gov.on.ca/idms/fhir/ValueSet/IDMS-Product-Types",
"description": "List of Product Types"
}
}, {
"id": "DocumentReference.category:ProductType.coding.display",
"min": 1,
"path": "DocumentReference.category.coding.display",
"short": "Display Value for the Product Type code"
}, {
"id": "DocumentReference.category:ProductType.coding.userSelected",
"max": "0",
"path": "DocumentReference.category.coding.userSelected"
}, {
"id": "DocumentReference.category:ProductType.text",
"max": "0",
"path": "DocumentReference.category.text",
"short": "Distinquishes this as the ProductType Code, has a fixed value of 'ProductType'",
"fixedString": "ProductType"
}, {
"id": "DocumentReference.category:SubmissionType",
"max": "1",
"path": "DocumentReference.category",
"sliceName": "SubmissionType"
}, {
"id": "DocumentReference.category:SubmissionType.extension",
"max": "0",
"path": "DocumentReference.category.extension"
}, {
"id": "DocumentReference.category:SubmissionType.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.category.coding"
}, {
"id": "DocumentReference.category:SubmissionType.coding.extension",
"max": "0",
"path": "DocumentReference.category.coding.extension"
}, {
"id": "DocumentReference.category:SubmissionType.coding.system",
"min": 1,
"path": "DocumentReference.category.coding.system",
"fixedUri": "https://health.gov.on.ca/idms/fhir/CodeSystem/Internal-Submission-Types"
}, {
"id": "DocumentReference.category:SubmissionType.coding.version",
"max": "0",
"path": "DocumentReference.category.coding.version",
"short": "Type of Code",
"definition": "This being used as the discriminator, it is the type of code. (The version of the code system is not relevant in IDMS so this is being reused)",
"fixedString": "SubmissionType"
}, {
"id": "DocumentReference.category:SubmissionType.coding.code",
"min": 1,
"path": "DocumentReference.category.coding.code",
"short": "This is the Submission Code",
"binding": {
"strength": "required",
"valueSet": "https://health.gov.on.ca/idms/fhir/ValueSet/IDMS-Submission-Types",
"description": "Submission Types"
}
}, {
"id": "DocumentReference.category:SubmissionType.coding.display",
"min": 1,
"path": "DocumentReference.category.coding.display",
"short": "This is the display Value for the Submission Code"
}, {
"id": "DocumentReference.category:SubmissionType.coding.userSelected",
"max": "0",
"path": "DocumentReference.category.coding.userSelected"
}, {
"id": "DocumentReference.category:SubmissionType.text",
"max": "0",
"path": "DocumentReference.category.text",
"short": "Distinquishes this as the SubmissionType Code, has a fixed value of 'SubmissionType'",
"fixedString": "SubmissionType"
}, {
"id": "DocumentReference.category:GenericClassification",
"max": "1",
"path": "DocumentReference.category",
"sliceName": "GenericClassification"
}, {
"id": "DocumentReference.category:GenericClassification.extension",
"max": "0",
"path": "DocumentReference.category.extension"
}, {
"id": "DocumentReference.category:GenericClassification.coding",
"max": "1",
"min": 1,
"path": "DocumentReference.category.coding"
}, {
"id": "DocumentReference.category:GenericClassification.coding.extension",
"max": "0",
"path": "DocumentReference.category.coding.extension"
}, {
"id": "DocumentReference.category:GenericClassification.coding.system",
"min": 1,
"path": "DocumentReference.category.coding.system",
"fixedUri": "https://health.gov.on.ca/idms/fhir/CodeSystem/Generic-Classification"
}, {
"id": "DocumentReference.category:GenericClassification.coding.version",
"max": "0",
"path": "DocumentReference.category.coding.version",
"short": "Type of Code"
}, {
"id": "DocumentReference.category:GenericClassification.coding.code",
"min": 1,
"path": "DocumentReference.category.coding.code",
"binding": {
"strength": "required",
"valueSet": "https://health.gov.on.ca/idms/fhir/ValueSet/IDMS-New-Generic-Classification",
"description": "Request Types"
}
}, {
"id": "DocumentReference.category:GenericClassification.coding.display",
"min": 1,
"path": "DocumentReference.category.coding.display",
"short": "This is the display Value for the Request Type"
}, {
"id": "DocumentReference.category:GenericClassification.coding.userSelected",
"max": "0",
"path": "DocumentReference.category.coding.userSelected"
}, {
"id": "DocumentReference.category:GenericClassification.text",
"max": "0",
"path": "DocumentReference.category.text"
}, {
"id": "DocumentReference.subject",
"max": "0",
"path": "DocumentReference.subject"
}, {
"id": "DocumentReference.context",
"max": "0",
"path": "DocumentReference.context"
}, {
"id": "DocumentReference.event",
"max": "0",
"path": "DocumentReference.event"
}, {
"id": "DocumentReference.bodySite",
"max": "0",
"path": "DocumentReference.bodySite"
}, {
"id": "DocumentReference.facilityType",
"max": "0",
"path": "DocumentReference.facilityType"
}, {
"id": "DocumentReference.practiceSetting",
"max": "0",
"path": "DocumentReference.practiceSetting"
}, {
"id": "DocumentReference.period",
"max": "0",
"path": "DocumentReference.period"
}, {
"id": "DocumentReference.date",
"max": "0",
"path": "DocumentReference.date"
}, {
"id": "DocumentReference.author",
"max": "0",
"path": "DocumentReference.author"
}, {
"id": "DocumentReference.attester",
"max": "0",
"path": "DocumentReference.attester"
}, {
"id": "DocumentReference.custodian",
"max": "0",
"path": "DocumentReference.custodian"
}, {
"id": "DocumentReference.relatesTo",
"max": "0",
"path": "DocumentReference.relatesTo"
}, {
"id": "DocumentReference.description",
"max": "0",
"path": "DocumentReference.description"
}, {
"id": "DocumentReference.securityLabel",
"max": "0",
"path": "DocumentReference.securityLabel"
}, {
"id": "DocumentReference.content",
"max": "1",
"path": "DocumentReference.content",
"definition": "#### **_`IDMS: The letter template.`_**"
}, {
"id": "DocumentReference.content.extension",
"max": "0",
"path": "DocumentReference.content.extension"
}, {
"id": "DocumentReference.content.modifierExtension",
"max": "0",
"path": "DocumentReference.content.modifierExtension"
}, {
"id": "DocumentReference.content.attachment",
"max": "1",
"path": "DocumentReference.content.attachment",
"definition": "#### **_`IDMS: Link to the letter template.`_**"
}, {
"id": "DocumentReference.content.profile",
"max": "0",
"path": "DocumentReference.content.profile",
"definition": "#### **_`IDMS: For generated letters the template that was used to generate the letter. The 'valueCoding.display' element is populated with the template name. `_**"
}, {
"id": "DocumentReference.content.profile.extension",
"max": "0",
"path": "DocumentReference.content.profile.extension"
}, {
"id": "DocumentReference.content.profile.modifierExtension",
"max": "0",
"path": "DocumentReference.content.profile.modifierExtension"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}