HL7 AU Conventions: profile and extension metadata

The following conventions apply to all HL7 AU StructureDefinition resources for standard profiles (of resources and datatypes) as well as extensions.

Resource elements

element	include	convention
filename		<id>'.xml' eg au-patient.xml
StructureDefinition.id	yes	1) For AU Base profiles: 'au-'<resource type in lower case> eg au-organization or au-allergyintolerance 2) for extensions: <use case in lower case with hyphens> eg no-fixed-address 3) for other HL7 AU profiles: 'au-'<use case in lower case with hyphens>; the use case doesn't have any conventions at this point
StructureDefinition.language	no
StructureDefinition.extension:structuredefinition-fmm	yes
StructureDefinition.url	yes	'http://hl7.org.au/fhir/StructureDefinition/'<id> eg http://hl7.org.au/fhir/StructureDefinition/au-patient
StructureDefinition.identifier	no
StructureDefinition.version	no	Semantic versioning strategy is in place. Versions are currently handled by ig.xml
StructureDefinition.name	yes	1) For AU Base profiles: the format for the name is <AU><use case><resource-type>. For example: without use case: where "Base" is the "" i.e. 'AUBase' e.g. AUBaseOrganization or AUBaseAllergyIntolerance and with use case: 'AU', the use case description does not have to match the id e.g. AUMedicineList or AUDiagnosticObservation 2) For extensions: <a description of the use case in upper camel case>, the use case description does not have to match the id e.g. NoFixedAddress
StructureDefinition.title	yes	The name with spaces e.g. No Fixed Address
StructureDefinition.status	yes	For a new StructureDefinition: 'draft'
StructureDefinition.experimental	no
StructureDefinition.date	no	Will be updated via the publishing process
StructureDefinition.publisher	yes	1) 'Health Level Seven Australia (Patient Administration WG)', or 2) 'Health Level Seven Australia (Orders and Observations WG)', or 3) 'Health Level Seven Australia (Medications WG)', or 4) 'Health Level Seven Australia' (for content not owned by a working group)
StructureDefinition.contact	yes	* contact.telecom.system value="url" * contact.telecom.value value="http://hl7.com.au" * contact.telecom.use value="work"
StructureDefinition.description	yes	1. if a Base Profile: 'This profile defines a <resource> structure that localises core concepts, including identifiers and terminology, for use in an Australian context.' 2. Extension: 'This extension applies to the <resource/element/datatype> and is used to indicate/represent ...' 3. Use case profiles 'This profile defines a ... in an Australian context.'
StructureDefinition.useContext	no
StructureDefinition.jurisdiction	yes	* jurisdiction.coding.system value="urn:iso:std:iso:3166" * jurisdiction.coding.value value="AU"
StructureDefinition.purpose	no
StructureDefinition.copyright	yes	1) Always present: 'HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.' 2) If the profile has a code that is a fixed value from SNOMED CT then the following content shall follow the standard statement: 'This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material.  No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted. All copies of this resource must include this copyright statement and all information contained in this statement.' 3) If the profile has a code that is a fixed value from LOINC then the following content shall follow the standard statement (refer to https://loinc.org/kb/license/ point 10.1): 'This material contains content from LOINC (http://loinc.org). LOINC is copyright © 1995-2022, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.'
StructureDefinition.kind	yes	1) Profile: 'resource' 2) Extension: 'complex-type'
StructureDefinition.abstract	yes	'false'
StructureDefinition.type	yes	<resourcename> OR 'Extension' OR <datatypename>